86 lines
2.0 KiB
Plaintext
86 lines
2.0 KiB
Plaintext
meta {
|
|
name: Activate
|
|
type: http
|
|
seq: 1
|
|
}
|
|
|
|
post {
|
|
url: {{baseurl}}/sim/activate
|
|
body: json
|
|
auth: inherit
|
|
}
|
|
|
|
body:json {
|
|
{
|
|
"iccid": "8934909001500561503"
|
|
}
|
|
}
|
|
|
|
body:form-urlencoded {
|
|
iccid: 123
|
|
offer: mensual
|
|
}
|
|
|
|
settings {
|
|
encodeUrl: true
|
|
timeout: 0
|
|
}
|
|
|
|
docs {
|
|
Campos de entrada:
|
|
```ts
|
|
// Header requerido
|
|
// > content-type:application/x-www-form-urlencoded
|
|
// > content-type:application/json
|
|
// Cualquiera de los 2 es valido
|
|
|
|
// Esquema body
|
|
{
|
|
iccid: string,
|
|
offer: "mensual" | "anual" | "SAVEFAMILY1" | "SAVEFAMILY2"
|
|
webhook?: string,
|
|
}
|
|
```
|
|
|
|
En el campo `offer` "mensual" equivale a "SAVEFAMILY2" y "anual" a "SAVEFAMILY1" porque se mantien los códigos de Oferta de Objenious por compatibilidad pero se espera usar "mensual" y "anual" y hacer la conversión en el servicio de cada proveedor.
|
|
|
|
Para las llamadas al webhook se va a usar siempre el metodo `POST`, ahora mismo no se firman los mensajes. Se introduce la URL completa tal que `https://dominion.com/v1/endpoint`.
|
|
|
|
Respuestas:
|
|
- **200**: OK
|
|
``` ts
|
|
// Esquema
|
|
{
|
|
iccid: string,
|
|
operation: string,
|
|
message_id: string, //uuidv7
|
|
}
|
|
```
|
|
``` json
|
|
// Ejemplo
|
|
{
|
|
"iccid": "89332011250651xxxxx",
|
|
"operation": "activation",
|
|
"message_id": "019dbeaf-8abb-7783-8b51-94fbd9f0b0df"
|
|
}
|
|
```
|
|
|
|
*iccid*: Confirmación del iccid enviado.
|
|
*operation*: Confirmación de la operacion que se ha aplicado.
|
|
*message_id*: Id de la operación, para consultar en orders.
|
|
|
|
> A futuro se va a incluir un campo `"ref":[]` para añadir los enlaces a las consultas de la operación. El body va a permitir tambien json.
|
|
|
|
- **402**: Algún campo es incorrecto
|
|
Se indica que campo es incorrecto, si hubiese mas de uno solo aparecería el primero en comprobarse.
|
|
```json
|
|
"errors": {
|
|
"msg": "La longitud del iccid es incorrecta debera ser de 19 caracteres",
|
|
"field": "iccid"
|
|
}
|
|
```
|
|
|
|
- **500**: Error general
|
|
Ha ocurrido un error imprevisto durante la
|
|
}
|