Ondernemingen, eindpunt
Een bedrijf vertegenwoordigt een klantenorganisatie, typisch een zaken. In de Reactor-API komen deze bedrijven overeen met 1:1 met de organisatie-id. API-gebruikers hebben alleen zichtbaarheid in de bedrijven waartoe ze toegang hebben. Een bedrijf kan vele eigenschappen. Een eigendom behoort tot precies één bedrijf.
De /companies
Het eindpunt in Reactor API staat u toe om de bedrijven programmatically terug te winnen die u binnen uw ervaringstoepassing toegang hebt tot.
Aan de slag
Het eindpunt dat in deze handleiding wordt gebruikt, maakt deel uit van de Reactor-API. Controleer voordat je doorgaat de gids Aan de slag voor belangrijke informatie over hoe te voor authentiek te verklaren aan API.
Een lijst met bedrijven ophalen list
U kunt een lijst maken van de bedrijven die u gemachtigd bent te gebruiken door een verzoek van de GET aan /companies
eindpunt. In de meeste gevallen is er precies één.
API-indeling
GET /companies
created_at
name
org_id
token
updated_at
Verzoek
curl -X GET \
https://reactor.adobe.io/companies \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
Antwoord
Een succesvolle reactie keert een lijst van bedrijven terug die u toegang tot hebt.
{
"data": [
{
"id": "COdb0cd64ad4524440be94b8496416ec7d",
"type": "companies",
"attributes": {
"created_at": "2020-08-13T17:13:30.667Z",
"name": "Example Company",
"org_id": "{ORG_ID}",
"updated_at": "2020-08-13T17:13:30.667Z",
"token": "d5a4f682bbae",
"cjm_enabled": false,
"edge_enabled": false,
"edge_events_allotment": null,
"edge_fanout_ratio": null
},
"relationships": {
"properties": {
"links": {
"related": "https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d/properties"
}
}
},
"links": {
"self": "https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d",
"properties": "https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d/properties"
},
"meta": {
"rights": [
"develop_extensions",
"manage_properties"
],
"platform_rights": {
"web": [
"develop_extensions",
"manage_properties"
],
"mobile": [
"develop_extensions",
"manage_properties"
]
}
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Een bedrijf opzoeken lookup
U kunt een specifiek bedrijf opzoeken door zijn identiteitskaart in de weg van een verzoek van de GET te omvatten.
API-indeling
GET /companies/{COMPANY_ID}
{COMPANY_ID}
id
waarde van het bedrijf u wilt opzoeken.Verzoek
curl -X GET \
https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
Antwoord
Een succesvol antwoord geeft de details van het bedrijf terug.
{
"data": {
"id": "COdb0cd64ad4524440be94b8496416ec7d",
"type": "companies",
"attributes": {
"created_at": "2020-08-13T17:13:30.667Z",
"name": "Example Company",
"org_id": "{ORG_ID}",
"updated_at": "2020-08-13T17:13:30.667Z",
"token": "d5a4f682bbae",
"cjm_enabled": false,
"edge_enabled": false,
"edge_events_allotment": null,
"edge_fanout_ratio": null
},
"relationships": {
"properties": {
"links": {
"related": "https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d/properties"
}
}
},
"links": {
"self": "https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d",
"properties": "https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d/properties"
},
"meta": {
"rights": [
"develop_extensions",
"manage_properties"
],
"platform_rights": {
"web": [
"develop_extensions",
"manage_properties"
],
"mobile": [
"develop_extensions",
"manage_properties"
]
}
}
}
}