Point d'entree de l'API (welcome)

Réponse exemple

{
  "auth": {
    "docs": "https://docs.coffrify.com/authentication",
    "type": "Bearer token",
    "header": "Authorization: Bearer cfy_<your_key>"
  },
  "name": "Coffrify API",
  "sdks": {
    "go": "https://github.com/coffrify/coffrify-go",
    "cli": "https://www.npmjs.com/package/@coffrify/cli",
    "python": "https://pypi.org/project/coffrify",
    "typescript": "https://www.npmjs.com/package/@coffrify/sdk"
  },
  "status": "https://status.coffrify.com",
  "contact": "help@coffrify.com",
  "openapi": "https://api.coffrify.com/v1/.well-known/openapi.json",
  "version": "v1",
  "idempotency": {
    "docs": "https://docs.coffrify.com/api/idempotency",
    "header": "Idempotency-Key",
    "replay_marker_header": "X-Coffrify-Idempotent-Replay"
  },
  "rate_limits": {
    "header_set": [
      "X-RateLimit-Limit",
      "X-RateLimit-Remaining",
      "X-RateLimit-Reset",
      "X-RateLimit-Policy"
    ],
    "tiers_per_minute": {
      "read": {
        "pro": 600,
        "free": 100,
        "ultra": 3000,
        "entreprise": 12000
      },
      "write": {
        "pro": 300,
        "free": 30,
        "ultra": 1500,
        "entreprise": 6000
      },
      "expensive": {
        "pro": 60,
        "free": 10,
        "ultra": 300,
        "entreprise": 3000
      }
    },
    "retry_after_on_429": true
  },
  "documentation": "https://docs.coffrify.com",
  "request_id_header": "X-Request-Id",
  "api_version_header": "X-Coffrify-Api-Version"
}

Le endpoint `GET /v1/welcome` est le point d'entree de la Reference API Coffrify. Il renvoie un instantane statique des metadonnees de la plateforme : nom et version de l'API, liens vers la documentation, la page de statut et le contact support, la liste des SDK officiels, le mode d'authentification attendu, les quotas de debit par palier et par classe d'endpoint, ainsi que les conventions d'en-tetes (versionnage, identifiant de requete, idempotence). C'est l'appel ideal pour verifier que votre client atteint bien l'API et pour decouvrir par programmation les ressources d'integration sans connaitre de cle prealable.

Authentification

Aucune authentification n'est requise et aucun scope n'est exige : l'endpoint est entierement public. Vous pouvez l'appeler sans en-tete Authorization. Si vous envoyez tout de meme une cle API valide, elle est ignoree par ce handler. La reponse decrit le schema d'authentification a utiliser pour les autres endpoints, a savoir un jeton porteur de la forme Authorization: Bearer cfy_<your_key>.

Reponse

La reponse 200 est un objet JSON aux champs stables. name et version identifient l'API. documentation, status et contact pointent respectivement vers la documentation, la page de statut et l'adresse support. sdks recense les SDK officiels (typescript, python, go, cli). Le bloc auth decrit le mode d'authentification (type, header, docs). openapi donne l'URL du schema OpenAPI. Le bloc rate_limits detaille les en-tetes de debit (header_set), la presence d'un Retry-After en cas de 429 (retry_after_on_429) et les quotas par minute (tiers_per_minute) ventiles par classe d'endpoint (read, write, expensive) et par palier (free, pro, ultra, entreprise). Enfin, api_version_header, request_id_header et le bloc idempotency documentent les conventions d'en-tetes de la plateforme.

Erreurs

Etant un endpoint public et statique, welcome ne renvoie pas d'erreur metier. Les seuls codes possibles proviennent du wrapper generique : une erreur serveur inattendue retourne un objet { "error": { "code": "internal_error", ... } }. Les codes d'authentification, de debit ou de validation ne s'appliquent pas ici.

Voir aussi

• GET /v1/.well-known/openapi.json : schema OpenAPI complet de l'API (URL exposee dans le champ openapi).
• Guide Authentification : creation et usage des cles cfy_.
• Guide Limites de debit et Idempotence : conventions referencees dans la reponse.