Please enable JavaScript.
Coggle requires JavaScript to display documents.
API (Une API "accessible" c'est : (Une page d'accueil…
API
Une API "accessible" c'est :
Des exemples de code prêts à l'usage (
sample code
) dans plusieurs langages de programmation pour illustrer les usages possibles de l'API
exemples
Chargify
Stripe
DWOLA
Des guides de démarrage (
getting started
)
pour permettre une compréhension de "haut niveau" de l'API
pour atteindre le premier "Hello World"
exemples
GitHub Rest API V3
Kinvey Rest API
Xero API
Office 365 REST APIs
Slack API
Braintree
De la
documentation
Exemples
Slate
: générateur open
source de
documentation statique,
compatible avec Swagger
exemples de doc
réalisées avec Slate
Clearbit
Liste d'exemples
Swagger2Slate
Swagger to Slate
Liste de générateurs de documentation
Liste de générateurs de documentation libre et open source
Etat de l'art 2016 des générateurs de documentation
Bonnes pratiques
Best practices
Best API documentation
UX tips
Des
cas d'utilisations
(use cases) qui décrivent les fonctionnalités de l'API dans un contexte significatif
à quoi elle peut servir
exemples
CU FIGO
CU vidéo API Orange SMS
CU Digital Oceans
CU ApIGee
à quoi on espère qu'elle serve
Une page d'accueil
qui répond à trois types de besoins :
curiosité / découverte
profil "chercheur"
démarrage
immédiat
profil "nouveau-venu"
résolution de problème
profil "débogueur"
exemples
HEROKU Dev Center
Bonnes pratiques
Le site web d'une API doit permettre de répondre aux besoins de 4 types d'audience
Bonnes pratiques
Le "nouveau-venu"
= le développeur qui cherche à démarrer
Le "débogueur"
= le développeur qui débogue un problème spécifique dans un client existant
Le "décideur"
= le CTO qui évalue les solutions concurrentes
Le "chercheur"
= le chef de projet qui cherche à identifier ce que l'API permet de faire
Indicateurs de suivi / d'évaluation d'une API
Trafic
total call
top methods
call chains
quota faults
Utilisateurs
total developers
active developers
top developers
trending apps
Service
performance
availability
error rates
code defects
Support
support ticket
response time
community metrics
Exemples d'API dans le domaine de l'environnement
exemple IGN
Site centralisé
Blog
Documentation
Galerie d'exemples
Espace Github
Forum d'entraide déporté
exemples américains
API USGS
Le site pour les développeurs de l'Agence US de protection de l'environnement (EPA)
USGS Waterservices
Texas State Water Plan API
Integrating Ocean ObservationSystem
National Snow and Ice Data Center
exemples européens
Netherlands Biodiversity API
Natural History Museum API
Meteomatics API
support utilisateur :
2 modes de support possibles
support "
peer-to-peer
" (entre utilisateurs) qui peut prendre la forme de :
Sites de communauté tierces
exemples
Xero API Stackoverflow
Swagger API Google Group
Sections communautaires / forums
exemples
Keen IO
ApiGee
support "
institutionnel
" (assuré par le producteur de l'API) qui peut prendre la forme de :
FAQ
exemples
Twillo
Dwolla
Base de connaissance
exemples
Digital Ocean
Formulaire de contact