Ponto de extremidade de empresas
Uma empresa representa uma organização de cliente, geralmente um negócio. Na API do Reator, essas empresas correspondem 1:1 à ID da organização. Os usuários da API só têm visibilidade das empresas às quais têm acesso. Uma empresa pode conter muitas propriedades. Uma propriedade pertence a exatamente uma empresa.
O ponto de extremidade /companies
na API do reator permite recuperar programaticamente as empresas às quais você tem acesso no aplicativo de experiência.
Introdução
O endpoint usado neste manual faz parte da API do Reactor. Antes de continuar, consulte o guia de introdução para obter informações importantes sobre como realizar a autenticação na API.
Recuperar uma lista de empresas list
É possível listar as empresas às quais você têm autorização de acesso fazendo uma solicitação GET para o ponto de extremidade /companies
. Na maioria dos casos, há exatamente um.
Formato da API
GET /companies
created_at
name
org_id
token
updated_at
Solicitação
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'
Resposta
Uma resposta bem-sucedida retorna uma lista de empresas às quais você tem acesso.
{
"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
}
}
}
Pesquisar uma empresa lookup
Você pode pesquisar uma empresa específica incluindo a respectiva ID no caminho de uma solicitação GET.
Formato da API
GET /companies/{COMPANY_ID}
{COMPANY_ID}
id
da empresa que você deseja pesquisar.Solicitação
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'
Resposta
Uma resposta bem-sucedida retorna os detalhes da empresa.
{
"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"
]
}
}
}
}