Ondernemingen, eindpunt

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Onderwerpen:

Gemaakt voor:

Ontwikkelaar

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 eigenschappenbevatten. Een eigendom behoort tot precies één bedrijf.

Het /companies eindpunt in Reactor API staat u toe om de bedrijven programmatically terug te winnen die u binnen uw ervaringstoepassing hebt toegang tot.

Aan de slag

Het eindpunt dat in deze gids wordt gebruikt maakt deel uit van Reactor API. Alvorens verder te gaan, te herzien gelieve begonnen gidsvoor belangrijke informatie betreffende 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 tot het /companies eindpunt te richten. In de meeste gevallen is er precies één.

API formaat

GET /companies

NOTE

Gebruikend vraagparameters, kunnen de beursgenoteerde bedrijven worden gefiltreerd gebaseerd op de volgende attributen:

created_at
name
org_id
token
updated_at

het filtreren reacties

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'

Reactie

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 formaat

GET /companies/{COMPANY_ID}

Parameter

Beschrijving

{COMPANY_ID}

De id waarde van het bedrijf u omhoog wilt kijken.

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'

Reactie

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"
        ]
      }
    }
  }
}

recommendation-more-help

12b4e4a9-5028-4d88-8ce6-64a580811743