Wat is een callback-URL in relatie tot een API?

Ik heb het internet afgespeurd en kan mijn hoofd niet om het idee van een terugbel-URL wikkelen. In mijn geval heb ik een paar callback-URL’s die ik zelf moet definiëren. Een populaire is een “standaard callback-URL”. Wat is dit precies? Kun je een voorbeeld geven in gewoon Engels?


Antwoord 1, autoriteit 100%

Een callback-URL wordt aangeroepen door de API-methode die u aanroept nadat deze is voltooid. Dus als je belt

POST /api.example.com/foo?callbackURL=http://my.server.com/bar

Als /fooklaar is, stuurt het een verzoek naar http://my.server.com/bar. De inhoud en methode van dat verzoek zullen variëren – controleer de documentatie voor de API die u gebruikt.


Antwoord 2, autoriteit 68%

Zie het als een brief. Soms krijg je een brief, bijvoorbeeld waarin je wordt gevraagd een formulier in te vullen en het formulier vervolgens terug te sturen in een voorgeadresseerde envelop die zich in de originele envelop bevindt waarin het formulier zat.

Als je klaar bent met het invullen van het formulier, stop je het in de meegeleverde retourenvelop en stuur je het terug.

De callbackUrl is als die retourenvelop. U zegt eigenlijk dat ik u deze gegevens stuur. Als je er klaar mee bent, wacht ik op deze callbackUrl op je reactie. Dus de API verwerkt de gegevens die u hebt verzonden en kijkt vervolgens naar de callback om u het antwoord te sturen.

Dit is handig omdat het soms lang kan duren voordat sommige gegevens zijn verwerkt en het geen zin heeft om de beller op een reactie te laten wachten. Stel dat uw API gebruikers in staat stelt om er documenten naar toe te sturen en deze op virussen te scannen. Daarna stuur je een rapport. De scan kan misschien 3 minuten duren. De gebruiker kan geen 3 minuten wachten. U bevestigt dus dat u het document hebt ontvangen en laat de beller doorgaan met andere zaken terwijl u de scan uitvoert en gebruikt vervolgens de callbackUrl om hem het resultaat van de scan te vertellen.


Antwoord 3, autoriteit 29%

Als u de callback-URL gebruikt, kan de API verbinding maken met de callback-URL en gegevens verzenden of ontvangen. Dat betekent dat API later (na API-aanroep) verbinding met u kan maken.

Voorbeeld

  1. JIJverzendt gegevens met een verzoek naar API
  2. APIverzendt gegevens met een tweede verzoek naar YOU

De exacte definitie zou in de API-documentatie moeten staan.


Antwoord 4, autoriteit 16%

Het is een mechanisme om een API op een asynchrone manier aan te roepen. De volgorde is als volgt

  1. uw app roept de url aan en geeft de callback-url door als parameter
  2. de api reageert met een 20x http-code (201 denk ik, maar raadpleeg de api-documenten)
  3. de api werkt gedurende een bepaalde tijd aan uw verzoek
  4. de api roept uw app op om u de resultaten te geven, op het callback-URL-adres.

U kunt dus de api aanroepen en uw gebruiker vertellen dat het verzoek bijvoorbeeld ‘in verwerking’ of ‘verworven’ is, en vervolgens de status bijwerken wanneer u het antwoord van de api ontvangt.

Ik hoop dat het logisch is.
-G


Antwoord 5, autoriteit 9%

Ik zal dit vrij eenvoudig voor je maken. Wanneer een transactie wordt geïnitieerd, gaat deze in de verwerkingsfase totdat deze de eindfase bereikt. Zodra het de terminalfase bereikt, wordt de transactiestatus door de betalingsgateway gepost naar de callback-URL die de handelaars over het algemeen gebruiken als referentie om de succes-/mislukkingspagina aan de gebruiker te tonen. Hoop dat dit helpt?


Antwoord 6, autoriteit 8%

Een ander gebruiksscenario kan zoiets zijn als OAuth, het wordt mogelijk niet rechtstreeks door de API aangeroepen, in plaats daarvan wordt de callback-URL door de browser aangeroepen nadat de verificatie met de identiteitsprovider is voltooid.

Normaal gesproken zal de identiteitsserviceprovider, nadat de eindgebruiker de sleutel in het gebruikersnaamwachtwoord heeft ingevoerd, een browseromleiding activeren naar uw “callback”-url met de tijdelijke autorisatiecode, b.v.

https://example.com/callback?code=AUTHORIZATION_CODE

Dan kan uw toepassing deze autorisatiecode gebruiken om een toegangstoken aan te vragen bij de identiteitsprovider die een veel langere levensduur heeft.

Other episodes