Apps

Documentación de API oauth2 - ejemplo v1

Índice
📁 Apps
📁 Adi_apps
📁 Oauth2
📁 Fcfm_productividad
URL https://api.campusdigital.cl/oauth2/v1/ejemplo
Autenticación Basic Auth | Token Bearer
Descripción API de ejemplo para documentación Esta API es un ejemplo de cómo documentar una API utilizando PHPDocBlock. Se espera que esta API no tenga una funcionalidad real, sino que sirva como referencia para la documentación de otras APIs en el sistema. Soporta actualmente dos métodos y se espera que los parámetros de entrada y salida estén en formato JSON. El texto de la documentación soporta Markdown para una mejor legibilidad, y se pueden incluir diagramas de secuencia utilizando la sintaxis de Mermaid para ilustrar el flujo de uso de la API. Un ejemplo de lista sería:
  • Elemento 1
  • Elemento 2
  • Elemento 3
Mientras que una secuencia de uso sería:
sequenceDiagram actor Cliente actor Servidor Cliente->>Servidor: Enviar solicitud a la API Servidor->>Cliente: Responder a la solicitud
Métodos GET | POST

GET

Descripción Obtiene los datos de un objeto de ejemplo
Formato JSON
Parámetros
  • id_objeto: string required - Identificador del objeto que se desea obtener
Retorno
  • id_objeto: string - Identificador del objeto solicitado
  • mensaje: string - Mensaje de respuesta de la API
  • objeto: array
    • nombre: string - Nombre del objeto
    • descripcion: string - Descripción del objeto
    • items: array
      • id: int - Identificador del item
      • nombre: string - Nombre del item
Ejemplos
PHP 
$ch = curl_init('https://api.campusdigital.cl/oauth2/v1/ejemplo/sample_id_objeto');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);
CURL 
curl -X GET 'https://api.campusdigital.cl/oauth2/v1/ejemplo/sample_id_objeto'
PYTHON 
import requests

url = 'https://api.campusdigital.cl/oauth2/v1/ejemplo/sample_id_objeto'
response = requests.request('GET', url)
print(response.text)

POST

Descripción Crea un nuevo objeto de ejemplo
Formato JSON
Parámetros
  • nombre: string required - Nombre del nuevo objeto que se desea crear
  • tipo: string optional - Tipo del nuevo objeto, por defecto es "general"
  • componentes: array
    • id: int - Identificador del componente
    • nombre: string - Nombre del componente
Retorno
  • mensaje: string - Mensaje de respuesta de la API
  • objeto: array
    • id: int - Identificador del nuevo objeto creado
    • nombre: string - Nombre del nuevo objeto creado
    • descripcion: string - Descripción del nuevo objeto creado
    • detalle: array
      • fecha_creacion: string - Fecha de creación del nuevo objeto
      • creado_por: string - Usuario o sistema que creó el nuevo objeto
    • componentes: array
      • id: int - Identificador del componente
      • nombre: string - Nombre del componente
Ejemplos
PHP 
$ch = curl_init('https://api.campusdigital.cl/oauth2/v1/ejemplo');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{\"nombre\":\"sample_nombre\",\"tipo\":\"sample_tipo\",\"componentes\":[{\"id\":12345,\"nombre\":\"sample_nombre\"}]}');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);

$response = curl_exec($ch);
curl_close($ch);
CURL 
curl -X POST 'https://api.campusdigital.cl/oauth2/v1/ejemplo' \
     -H 'Content-Type: application/json' \
     -d '{"nombre":"sample_nombre","tipo":"sample_tipo","componentes":[{"id":12345,"nombre":"sample_nombre"}]}'
PYTHON 
import requests

url = 'https://api.campusdigital.cl/oauth2/v1/ejemplo'
payload = {
    "nombre": "sample_nombre",
    "tipo": "sample_tipo",
    "componentes": [
        {
            "id": 12345,
            "nombre": "sample_nombre"
        }
    ]
}
response = requests.request('POST', url, json=payload)
print(response.text)