Programas externos

Obtener un programa externo

GET

/external/{id}

curl --request GET \
  --url https://hub.grou.com/api/ext/external/{id} \
  --header 'Authorization: Bearer <token>'

{
  "checkout_url": "<string>",
  "content": {
    "modules": [
      {
        "description": "<string>",
        "id": "<string>",
        "lessons": [
          {
            "id": "<string>",
            "name": "<string>",
            "provider": "<string>",
            "video_url": "<string>"
          }
        ],
        "name": "<string>",
        "sessions": [
          {
            "date": "<string>",
            "id": "<string>",
            "title": "<string>"
          }
        ]
      }
    ]
  },
  "created_at": "2023-11-07T05:31:56Z",
  "external_ref": "<string>",
  "id": "<string>",
  "state": "draft",
  "type": "program",
  "updated_at": "2023-11-07T05:31:56Z",
  "version_id": "<string>"
}

Autorizaciones

Authorizationstringheaderobligatorio

Tu API Key del Hub (Configuración → API Keys), que empieza por sk_. Solo se muestra una vez al generarla.

Parámetros de ruta

idstringobligatorio

El id del recurso, tal como lo devolvió la API.

Respuesta

El programa externo.

checkout_urlstring | nullobligatorio

Link de pago. Solo cuando el recurso está published.

contentobject

El contenido con el id de cada elemento, para enviarlo de vuelta al editar.

Mostrar child attributes

created_atstringobligatorio

external_refstring | null

Tu identificador, si lo enviaste al crear.

idstringobligatorio

stateenum<string>obligatorio

draft: borrador, no visible para compradores. published: a la venta, con checkout_url. unpublished: retirado de la venta, se puede volver a publicar.

Opciones disponibles: draft, published, unpublished

typeenum<string>obligatorio

Opciones disponibles: program, external, workshop, checkout

updated_atstringobligatorio

version_idstring | null

Versión actual. Siempre null en checkouts.

¿Aún necesitas ayuda? Comparte una idea