Disclaimer: Dit artikel is gegenereerd door automatische vertaling.
Plannen ter ondersteuning van API documentatie
| Professional | Business | Enterprise |
|---|---|---|
De API-documentatiefunctie in Document360 biedt een complete oplossing voor het maken en beheren van API-verwijzingen. Met deze functie kunt u hoogwaardige API-documentatie genereren die gebruikers helpt uw API's te begrijpen en er effectief mee te werken. U kunt deze documentatie genereren door het API-specificatiebestand te uploaden vanaf een URL, een JSON/YAML-bestand of door te integreren met een CI/CD-stroom.
Daarnaast kunt u met de functie Try it! in Document360 API-eindpunten rechtstreeks op de Knowledge base sitetesten. De interactieve console op de Knowledge Base-site stelt ontwikkelaars in staat om de benodigde parameters in te voeren en API-aanroepen uit te voeren, waardoor realtime antwoorden worden verkregen. Deze functie is handig voor het oplossen van problemen en om te begrijpen hoe een API zich gedraagt zonder de documentatie te verlaten of code te schrijven.
Autorisatie technieken
Bij interactie met een API is het belangrijk om ervoor te zorgen dat alleen geautoriseerde gebruikers toegang hebben tot bepaalde gegevens of specifieke acties kunnen uitvoeren. Dit wordt gedaan met behulp van autorisatietechnieken, die de toegang en machtigingen beheren. Document360 ondersteunt verschillende autorisatiemethoden om uw API te beveiligen, waaronder:
Basisverificatie: Vereist een gebruikersnaam en wachtwoord die in het verzoek worden doorgegeven.
Token aan toonder: UAuthenticeert met een token dat wordt gegenereerd na het inloggen.
API-sleutel: Gebruikt een unieke sleutel, die wordt doorgegeven in de aanvraagheaders, voor verificatie.
OAuth2: Beveiligt API's via verschillende stromen, zoals autorisatiecode, PKCE, clientreferenties en impliciete stromen.
OpenID Connect: Breidt OAuth2 uit door gebruikersidentiteitsverificatie toe te voegen.
Overwegingen bij autorisatie (OAuth2 en OpenID)
Bij het werken met API's die OAuth2 of OpenID gebruiken voor autorisatie, zijn bepaalde instellingen essentieel voor een goede functionaliteit.
Omleidings-URI: Dit is de URL waarnaar de gebruiker wordt omgeleid na het voltooien van een autorisatiestroom. Zorg ervoor dat u de URI instelt in de indeling:
domain/oauth. Bijvoorbeeld:https://apidocs.document360.com/oauth.Stille verlenging: Bij stille verlenging wordt het autorisatietoken automatisch op de achtergrond vernieuwd, zodat gebruikers zich niet opnieuw hoeven te verifiëren tijdens hun sessie. Hierdoor blijft hun sessie zonder onderbreking actief. Om te voorkomen dat de autorisatie verloopt tijdens sessies waarin gebruikers interactie hebben met de functie Try It! , vernieuwt Document360 automatisch het vernieuwingstoken op de achtergrond. Dit zorgt ervoor dat gebruikers zich niet handmatig opnieuw hoeven te authenticeren.
Aankoop
Je krijgt toegang tot 1 API-werkruimte als onderdeel van alle betaalde Document360-abonnementen (Professional, Business en Enterprise). Als u extra API-werkruimten wilt aanschaffen,
Navigeer naar Instellingen > Kennisbankportal > Facturering > Mijn abonnement.
Klik op Add-on kopen.
Voeg het gewenste aantal werkruimten voor API-documentatie toe. Bekijk de kosten van de add-on en het verschuldigde bedrag.
Klik op Betaling bevestigen om door te gaan met de betaling.
VEELGESTELDE VRAGEN
Wat is een API-referentie?
Een API-referentie is een documentatiebron die uitgebreide informatie biedt over de functies, klassen, methoden, parameters, retourtypen en andere componenten van een API. Het is een gids of handleiding voor ontwikkelaars die de API willen integreren of gebruiken in hun applicaties.
Hoeveel API-verwijzingen kan ik maken met Document360 API-documentatie?
Binnen elke API-werkruimte kunt u maximaal 3 API-verwijzingen aanmaken.
De optie "Probeer het!" is niet beschikbaar op de Knowledge Base-site. Wat zou de reden kunnen zijn?
Als de functie Probeer het! niet zichtbaar is op de Knowledge Base-site, zorg er dan voor dat zowel de servervariabele als de URL correct zijn gedefinieerd in uw API-specificatiebestand. Zonder deze zal de functie niet werken.
Wat zijn de ondersteunde specificatiebestandsindelingen?
U kunt uw specificatiebestand uploaden als een URL-, JSON- of YAML-bestand. Document360 ondersteunt OpenAPI 2.0, OpenAPI 3.0 en Postman API-specificaties.
Gerelateerde video's
Ervaar onze moderne API-documentatie in Document360 als nooit tevoren
Test API-eindpunten rechtstreeks vanuit de documentatie met de functie Probeer het
Aanvullende informatie
Introductie van API-documentatie: verbeter uw API-ervaring - Klik om te lezen