Partager via

Service d’installation d’application

Ce service permet aux développeurs d’applications d’installer des applications sur les systèmes clients.

API REST

Méthode Endpoint Description
GET https://api.appnexus.com/app-installation Afficher toutes les installations
GET https://api.appnexus.com/app-installation?id=ID Afficher une installation spécifique
POST https://api.appnexus.com/app-installation Installer une application pour un client
PUT https://sand.api.appnexus.com/app-installation?id=ID Mettre à jour une installation d’application
DELETE https://api.appnexus.com/app-installation?id=ID Supprimer une installation d’application

Champs JSON

Champ Type Description
accepted_permissions valeur booléenne Indique si l’autorisation a été reçue pour accéder aux zones requises par l’application à utiliser.
addendum string Il contient le texte du contrat qui s’affiche lorsqu’un utilisateur installe l’application. Ce champ peut être modifié à l’aide du langage de balisage Markdown .
has_payment_access valeur booléenne Indique si les conditions de paiement et les frais peuvent être appliqués à cette application.
En lecture seule.
Par défaut : true
id int Numéro d’identification unique de chaque installation instance.
Requis : PUT et DELETE
installed_on Timestamp Date et heure d’installation de cette application par l’utilisateur.
En lecture seule
installer_user_id int Identification unique de l’utilisateur autorisé à installer des applications à partir de la Place de marché des applications. Il s’agit également de l’utilisateur qui peut accepter ou rejeter les contrats d’addendum.
En lecture seule
log_level_data_fee int Frais facturés à l’utilisateur pour consommer des données au niveau du journal.
En lecture seule
permissions tableau d’objets Opérations que l’application peut effectuer pour le compte de l’utilisateur actuellement connecté. Pour plus d’informations, consultez Autorisations ci-dessous.
plugin_id int Numéro d’identification unique du plug-in installé dans cette instance.
Obligatoire : POST
subscriber_email string Adresse e-mail de la personne de contact spécifiée au niveau du programme d’installation de l’application.
En lecture seule
subscriber_entity_id int Numéro d’identification unique du parent de l’utilisateur qui a installé l’application.
Obligatoire : POST
subscriber_entity_type enum Organization parent de l’utilisateur qui a installé l’application. Les valeurs possibles sont ou "member""bidder". Lors de l’ajout d’une installation, vous devez choisir l’option appropriée pour ( subscriber_entity_id ci-dessous).
subscriber_name string Nom de la personne à contacter au niveau du programme d’installation de l’application.
En lecture seule
subscriber_phone chaîne Numéro de téléphone de la personne à contacter spécifiée au niveau du programme d’installation de l’application.
En lecture seule

Autorisations

Chaque objet du permissions tableau contient les champs suivants :

Champ Type Description
privileges tableau d’objets Les types d’appels que l’application peut effectuer au service d’API et les champs spécifiques qui peuvent être utilisés. Consultez privileges l’exemple.
Dans chaque objet, method définit les appels qui peuvent être effectués au service ("get", , "post""put"ou "delete"), et fields limite les autorisations à des champs spécifiques dans le service. Si fields a la valeur null, les autorisations s’appliquent à tous les champs du service. Notez que l’utilisation de la "delete" méthode doit être approuvée par un représentant Xandr.
service enum Nom du service d’API que l’application est autorisée à utiliser.

privileges Exemple

{
"method": "get",
"fields": null
}

Exemples

Afficher toutes les installations

$ curl -b cookies -c cookies 'https://api.appnexus.com/app-installation'
{
    "response":{
        "status":"OK",
        "count":1,
        "start_element":0,
        "num_elements":100,
        "app-installations":[
            {
                "id":9,
                "plugin_id":47,
                "addendum":"This is test text to demonstrate the addendum functionality.",
                "subscriber_entity_type":"member",
                "subscriber_entity_id":3754,
                "accepted_permission":false,
                "installed_on":"2013-05-01 20:58:28",
                "installer_user_id":5447,
                "permissions":null,                     
                "has_payment_access":false   
                "log_level_data_fee":5500,
                "subscriber_phone":"",
                "subscriber_email":"zivester@appnexus.com",
                "subscriber_name":"Zach Ivester"
            }
        ],
        "dbg_info":{
            ...
        }
    }
}

Afficher une installation spécifique

$ curl -b cookies -c cookies 's://sand.api.appnexus.com/app-installation?id=868'
{
    "response":{
        "status":"OK",
        "count":1,
        "start_element":null,
        "num_elements":null,
        "app-installation":{
            "id":868,
            "plugin_id":4,
            "entity_type":"bidder",
            "entity_id":226,
            "status":"installed"
        }
    }
}

Installer une application sur un client

$ cat add-app-installation.json
{
    "app-installation":
        {
        "plugin_id": "20",
        "subscriber_entity_type": "member",
        "subscriber_entity_id":  "238"
        }
}
$ curl -b cookies -c cookies -X POST -d @add-app-installation.json 's://api.appnexus.com/app-installation' | json-pp
{
    "response":{
        "status":"OK",
        "count":1,
        "id":18716,
        "start_element":0,
        "num_elements":100,
        "app-installation":{
            "id":18716,
            "plugin_id":20,
            "addendum":null,
            "subscriber_entity_type":"member",
            "subscriber_entity_id":238,
            "accepted_permission":true,
            "installed_on":"2013-05-13 12:54:50",
            "installer_user_id":3052,
            "permissions":null,                     
            "has_payment_access":false   
            "log_level_data_fee":null,
            "subscriber_phone":null,
            "subscriber_email":null,
            "subscriber_name":"Netseer - member 238"
        },
        "dbg_info":{
            ...
        }
    }
}

Mettre à jour une installation d’application

$ cat update-app-installation.json
{
    "app-installation": 
        {
        "plugin_id": "19",
        "addendum": "www.site.com",
        "accepted_permission": false,
        "log_level_data_fee": "2000",
        "subscriber_phone": "914-555-1212",
        "subscriber_email": "JMS@live.com",
        "subscriber_name": "Ben Smith"
        }
} 
$ curl -b cookies -c cookies -X PUT -d @update-app-installation.json 's://api.appnexus.com/app-installation?id=23'
{
    "response":{
        "status":"OK",
        "count":1,
        "id":"23",
        "start_element":0,
        "num_elements":100,
        "app-installation":{
            "id":23,
            "plugin_id":50,
            "addendum":null,
            "subscriber_entity_type":"member",
            "subscriber_entity_id":185,
            "accepted_permission":false,
            "installed_on":"2013-05-07 15:05:45",
            "installer_user_id":43,
            "permissions":null,                     
            "has_payment_access":false   
            "log_level_data_fee":2500,
            "subscriber_phone":"",
            "subscriber_email":"PQ5ejohnson@appnexus.com",
            "subscriber_name":"Emily HB"
        },
        "dbg_info":{
            ...
        }
    }
}

Supprimer une installation d’application

$ curl -b cookies -c cookies -X DELETE 'https://api.appnexus.com/app-installation?id=121'
{
    "response":{
        "status":"OK",
        "count":1,
        "start_element":0,
        "num_elements":100,
        "dbg_info":{
            ...
        }
    }
}
  • Last updated on