Leer en inglés

Compartir a través de


Licitadores: servicio de usuario

En este caso, "usuario" hace referencia a personas o grupos que usan las API de Xandr. El servicio de usuario le permitirá administrar quién tiene acceso a las API de Xandr. Los usuarios se clasifican como por un tipo de usuario de postor o miembro.

  • Otros usuarios del pujador pueden crear usuarios pujantes.
  • Un usuario pujador puede crear y actualizar usuarios miembros, así como actualizar su propia información de usuario.
  • Un usuario miembro puede actualizar su propia información de usuario.
  • Cada nuevo nombre de usuario asociado a un pujador determinado debe ser único.

API de REST

Http (método) Endpoint Description
GET https://api.adnxs.com/user Vea todos los usuarios que ha creado.
GET https://api.adnxs.com/user/USER_ID Ver un usuario determinado.
POST https://api.adnxs.com/user (JSON de usuario) Agregar un usuario.
PUT https://api.adnxs.com/user/USER_ID (JSON de usuario) Modificar un usuario existente.

Para eliminar un usuario existente:
DELETE https://api.adnxs.com/user/USER_ID

Estructura JSON

Campo Obligatorio Tipo Descripción
id Sí (al actualizar) Entero Identificador interno asociado al usuario.
Activo no Bool Actualmente no se puede eliminar un usuario. Por ahora, establezca en activo en "false".
usuario Sí (al agregar) string(50) Nombre del usuario. Los nombres de usuario deben ser únicos.

Nota: Después de crear un usuario, no se puede cambiar el nombre de usuario.
contraseña Sí (al agregar) string Contraseña para el usuario.
correo electrónico string Email del usuario. (Tenga en cuenta que se puede crear un usuario sin un correo electrónico, pero esto provocará problemas más adelante al intentar actualizar el usuario).
user_type enum('bidder','member') Tipo de usuario que se va a agregar.
read_only no Booleano Los usuarios con read_only campo establecido en true no pueden agregar, modificar ni eliminar recursos.
entity_id Sí (al agregar) Entero Identificador de la entidad a la que pertenece el usuario (miembro o licitador). Si el user_type es "postor", este es el identificador del pujador. Si el user_type es "miembro", este es el identificador de miembro.
entity_name no string Nombre de la entidad a la que pertenece el usuario (miembro o licitador).
First_name no string Nombre del usuario
last_name no string Apellidos del usuario
phone no string Contacto telefónico del usuario
publisher_id no string Este campo solo se usa para Displaywords
advertiser_id no string Este campo solo se usa para Displaywords
advertiser_access no matriz de objetos Los anunciantes a los que el usuario puede acceder, si user_type es "member_advertiser".
publisher_access no matriz de objetos Los publicadores a los que el usuario puede acceder, si user_type es "member_publisher".
api_login no Booleano True si el usuario tiene acceso a la API. El valor predeterminado es False.
Se trata de un campo de solo administrador. Si crea un nuevo usuario que necesita acceso a la API, póngase en contacto con el servicio de atención al cliente para solicitar que este valor se establezca en True.
custom_data no string Cualquier información relevante para el usuario.
send_safety_budget_notifications no Booleano Si truees , el usuario recibirá notificaciones por correo electrónico cuando se acerque el umbral diario del presupuesto de seguridad. Para obtener más información, consulte el daily_budget campo en el servicio para miembros.
Timezone no string Zona horaria del usuario.
entity_reporting_decimal_type no string Si los valores numéricos están separados por una coma o un decimal en los informes. Si este campo se establece en decimal, el valor devuelto tendría el formato siguiente: 1234.56. Mientras que, si este campo se establece en comma, el valor devuelto tendría el formato siguiente: 1234.56.
Posibles valores:
- decimal
- comma
reporting_decimal_type no string Carácter usado para decimales en los informes. Posibles valores:
- "comma"
- "decimal" (punto)
Esta configuración se puede invalidar en el nivel de informe (consulte reporting_decimal_type en el servicio de informes).
decimal_mark no string Carácter utilizado para representar una marca decimal, como "punto" para un valor de 12,7.
thousand_seperator no string Carácter usado para separar miles en valores numéricos, como "coma" para el valor 1,276.
last_modified no date La fecha en que se modificó por última vez cualquiera de los valores de configuración de usuario.
is_developer no Booleano Solo lectura. Esta marca proporciona a un usuario derechos para acceder a determinados servicios centrados en desarrolladores, como los servicios de complemento e instancia de complemento, que usan las aplicaciones. Un administrador de Xandr lo establece en true caso por caso.
role_id no Entero Identificador del rol asociado a este usuario.
password_expires_on no date Fecha de expiración de la contraseña de usuario.
password_last_changed_on no date La fecha en que se cambió por última vez la contraseña del usuario.

Ejemplos

Token de autenticación

La autenticación siempre es el primer paso cuando se usan los servicios de API. A continuación, el token de autenticación se puede escribir en nuestro archivo de cookies para su uso futuro. Consulte Servicio de autenticación para obtener instrucciones más detalladas.

Create un archivo de texto de perfil de usuario

Para conceder acceso a la API a "TestUser", creará un archivo de texto en formato JSON con el nombre de usuario y la contraseña del usuario, y el identificador de un miembro o pujador al que pertenecerá este usuario. A continuación, hemos usado el comando "cat" para generar un archivo JSON de usuario de ejemplo.

$ cat user
{
   "user":{
      "username":"TestUser",
      "password":"2323test",
      "entity_id":7,
          "email": "user1@examplecompany.com",
          "user_type": "bidder"
   }
}

Directrices para crear la contraseña

Al crear la contraseña, cree una contraseña compleja con lo siguiente:

  • 10 o más caracteres
  • 64 caracteres o menos
  • Al menos una letra mayúscula (A–Z)
  • Al menos una letra minúscula (a–z)
  • Al menos un dígito (0–9)
  • Al menos un carácter especial (como #, $, ? %, &)

Adición de un nuevo usuario a la caché de Imp Bus

Ahora introduciremos el archivo de usuario. Hemos usado cookies para autenticarnos.

$ curl -b cookies -c cookies -X POST --data-binary @user https://api.adnxs.com/user
{
   "response":{
      "status":"OK",
      "id":59
   }
}

Recuperar información de usuario de la memoria caché de Imp Bus

Sabemos por la salida del comando anterior que el usuario que acabamos de agregar ha sido asignado id. n.º 59 por imp bus. Podemos usar ese identificador para ver información sobre este usuario en particular. Para ver todos los usuarios que hemos creado, dejaremos fuera el identificador de usuario.

$ curl -b cookies -c cookies https://api.adnxs.com/user/59
{
  "response": {
    "status": "OK",
    "count": 1,
    "start_element": null,
    "num_elements": null,
    "user": {
      "id": 59,
      "active": true,
      "first_name": null,
      "last_name": null,
      "phone": null,
      "username": "TestUser",
      "email": "user1@examplecompany.com",
      "user_type": "bidder",
      "read_only": false,
      "api_login": false,
      "entity_id": 7,
      "publisher_id": null,
      "advertiser_id": null,
      "custom_data": null,
      "send_safety_budget_notifications": false,
      "entity_name": "Platform Services Test Bidder",
      "timezone": null,
      "entity_reporting_decimal_type": null,
      "reporting_decimal_type": null,
      "decimal_mark": "period",
      "thousand_separator": "comma",
      "last_modified": "2017-02-16 19:06:47",
      "is_developer": false,
      "role_id": null,
      "languages": null,
      "advertiser_access": null,
      "publisher_access": null
    },
    "dbg": {
                ...
    }
  }
}

Solicitud de acceso a la API

Observe en el código devuelto encima del campo api_login . Este campo solo lo puede cambiar un administrador de Xandr. El último paso para proporcionar a un usuario acceso a la API es ponerse en contacto con el soporte técnico del cliente y solicitar que la marca de api_login para el usuario se establezca en true. Asegúrese de incluir el nombre de usuario o el identificador en la solicitud.

Servicios de API