Inleiding
Het op accountnummer gebaseerde abonnement voor Advanced Integrated Visibility is ontworpen voor abonnees van Advanced Integrated Visibility om hun op accountnummer gebaseerde Advanced Integrated Visibility-projecten te beheren en om projectgerelateerde bewerkingen uit te voeren, zoals het bewerken en bekijken van gegevens met behulp van API-eindpunten.
Opmerking:
- U moet beheerderstoegang hebben voor uw API-project waarbij deze API is ingeschakeld.
- Ga naar de pagina Documentatie over Advanced Integrated Visibility voor meer informatie over Advanced Integrated Visibility en zijn functies.
Voordelen van op accountnummer gebaseerd abonnement voor Advanced Integrated Visibility
De voordelen van op accountnummer gebaseerde abonnementen voor Advanced Integrated Visibility zijn:
- U kunt uw Advanced Integrated Visibility-project eenvoudig bijwerken en beheren met behulp van de API-eindpunten.
- Met deze API kunt u in één API-transactie meerdere accounts aan uw project koppelen, in plaats van elk account een voor een te selecteren.
Hoe op accountnummer gebaseerde abonnementen voor Advanced Integrated Visibility werken
Gebruik de onderstaande eindpunten om uw Geavanceerde geïntegreerde zichtbaarheid-project te beheren:
Advanced Integrated Visibility-project bijwerken
Gebruik dit eindpunt om alle gegevens van Advanced Integrated Visibility-projecten in uw organisatie bij te werken.
De invoerinformatie voor dit verzoek is:
- requestType: geef het type verzoek om bijwerking op.
- ADD_ACCOUNTS: gebruik deze optie om nieuwe accounts aan het bestaande project toe te voegen als de organisatie al is gekoppeld aan het Advanced Integrated Visibility-project voor alle accounts.
- DELETE_ACCOUNTS: gebruik deze optie om een account uit het project te verwijderen.
- UPDATE_ALL: gebruik deze optie voor regelmatige projectupdates.
Opmerking: dit is een optioneel element en UPDATE_ALL wordt standaard geselecteerd als het niet door de gebruiker is opgegeven. - category: geef de categorie op van de functie die u voor het project wilt bijwerken. Bijvoorbeeld: RETRY_POLICY, PROOF_OF_DELIVERY, etc.
- subCategories: specificeer de individuele kenmerken voor de geselecteerde functiecategorie. Bijvoorbeeld: BASIC_HRS, PPOD, SPOD, SHIP, TRAN, etc.
De geslaagde respons op dit verzoek retourneert de abonnements-ID, een indicator als het project voor alle accounts in de organisatie is bijgewerkt en een tijdstempel voor het bijgewerkte project.
Projectgegevens ophalen
Gebruik dit eindpunt om de projectgegevens voor een gespecificeerd Advanced Integrated Visibility-project in een gepagineerde indeling op te halen.
De vereiste invoerinformatie voor dit verzoek is:
- authorization: geef het autorisatietoken op.
- subscriptionId: geef de abonnements-ID op voor het Advanced Integrated Visibility-project om de gegevens op te halen.
De geslaagde respons op dit verzoek retourneert de gegevens van het gespecificeerde webhookproject in een gepagineerde indeling of retourneert een waarschuwing of foutgegevens in geval van mislukkingen.
Bedrijfsregels
- Er kunnen maximaal 30.000 verzendaccountnummers worden gekoppeld aan een Advanced Integrated Visibility-project in elk verzoek.
Response