Obtener la organización

GET

/v1/organization

curl --request GET \
  --url https://api.iomza.com/v1/organization \
  --header 'Authorization: Bearer <token>'

• Producción

La organización a la que pertenece la clave, los límites de su plan y el uso de este mes.

Autorizaciones

• apiKey

Respuestas

200

La organización.

Tipo de contenidoapplication/json

Una organización con su plan y el uso de este mes.

object

id

obligatorio

string

object

obligatorio

string

Valor permitido: organization

name

obligatorio

string

plan

obligatorio

Los límites de un plan.

object

code

obligatorio

Nombre estable (“free”, “pro”…).

string

name

obligatorio

El nombre que ven las personas.

string

modules

obligatorio

Los módulos que incluye (transcoding…).

Array<string>

Valores permitidos: transcoding live

max_concurrent_jobs

obligatorio

Cuántos jobs corren a la vez; el resto espera en queued.

number

monthly_minutes

obligatorio

Minutos de video procesados al mes, contados sobre la fuente (o el clip); null si son ilimitados.

number | null

max_upload_bytes

obligatorio

El archivo fuente más grande, en bytes.

number

modules

obligatorio

Los módulos que tiene: los de su plan, con sus propias excepciones aplicadas.

Array<string>

Valores permitidos: transcoding live

webhook_secret

obligatorio

El secreto con el que se firman los webhooks (whsec_…); solo se muestra a propietarios y administradores en el panel, null en los demás casos.

string | null

usage

obligatorio

object

processed_minutes_this_month

obligatorio

Minutos de fuente procesados en este mes natural (UTC).

number

monthly_minutes

obligatorio

Los minutos mensuales del plan; null si son ilimitados.

number | null

average_speed_this_month

obligatorio

Segundos de video por segundo de proceso en los jobs terminados este mes (30 = 30× tiempo real); null antes del primero.

number | null

created_at

obligatorio

string formato: date-time

Ejemplo

{
  "object": "organization",
  "plan": {
    "modules": [
      "transcoding"
    ]
  },
  "modules": [
    "transcoding"
  ]
}

401

La API key falta, no es válida o está revocada.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

404

No existe en tu organización.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

429

Demasiadas peticiones: espera y reintenta. Lo responde la pasarela, así que el cuerpo puede ser distinto.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

500

Nuestro: reintenta, y avísanos si persiste.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

503

No disponible por un momento: reintenta en unos segundos.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}