DocID®Documentación de DocID®
Volver a DocID®
  • Resumen

    • Documentación de DocID®
  • Introducción

    • Introducción
    • Cómo funciona DocID®
    • Conceptos clave
  • Primeros pasos

    • Primeros pasos
    • Módulo de Drupal
    • Plugin de WordPress
    • Sitio web a medida
    • Checklist de puesta en producción
  • Funcionalidades

    • Funcionalidades
    • Standard Login
    • Acceso y personalización
    • Analytics
    • Campaigns
  • Licencias

    • Licencias
  • OAuth 2.0

    • OAuth 2.0
    • Configurar un cliente
    • Flujo Authorization Code
    • Scopes y UserInfo
    • Seguridad y entornos
  • API

    • API
  • Ayuda

    • Solución de problemas

API

API

Utilice la referencia interactiva de la API de DocID® para las Business Resources compatibles.

La DocID® Business API se documenta mediante una interfaz Swagger interactiva.

Abrir la referencia interactiva de la API

El documento OpenAPI legible por máquinas está disponible en:

1https://docid.pro/api/openapi.json

API frente a OAuth

Utilice los endpoints de OAuth 2.0 para autenticar a un visitante del sitio web y recuperar la información de identidad autorizada.

Utilice la Business API para las Management Resources y Application Resources descritas en el documento OpenAPI. Los Authentication Requirements, Request Schemas, Responses y Error Codes se especifican para cada operación en la referencia interactiva.

Uso seguro de la API

  • Llame a las operaciones con privilegios desde código server-side de confianza.
  • Utilice las credenciales previstas para el entorno actual.
  • Valide cada response y gestione los Status Codes que no indiquen éxito.
  • No registre Authorization Headers ni Response Data sensibles.
  • Utilice los identifiers documentados en lugar de deducir las Resource Relationships.
AnteriorSeguridad y entornosSiguienteSolución de problemas

En esta página

  1. API frente a OAuth
  2. Uso seguro de la API