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)
脕rea de Infotecnolog铆as
Facultad de Ciencias Fisicas y Matematicas
Universidad de Chile