developer.create

This section provides documentation on the v1.0 version of the Mashery API.  We will support previously built applications and integration points, but not granting new access keys.  These pages are for legacy support purposes.  Should you wish to integrate with your Mashery instance, please utilize Mashery API version 2.0.

Description

Creates a new developer for a Mashery Service Provider.

Authentication

This method requires authentication

Parameters Type Description Required
spkey string Service Provider key assigned by Mashery Yes
email string
 Developer's email address
 Yes
apikey string API key for this developer. If set to _auto_, an API key will be automatically generated and returned in the response. Yes
status string Status of this developer's account. May be one of waiting, active(default), inactive, deleted or disabled. If omitted, active status will be assumed.
 No
first_name string Developer's first name
 No
last_name string Developer's last name No
groups array List of groups this developer belongs to. If omitted or set to null, the developer is created in the developer group. No
secret string Shared secret between Service Provider and Developer. May be used for signing requests. If set to _auto_, a secret will be automatically generated and returned in the response. No
limits object Specifies limits related to the new developer at time of creation. See developer.setLimits for complete documentation and definition of the available options. No

Response

array|object — Success/failure of the call determined by the boolean success property, and the properties stored with the new developer are returned in the properties property.

Examples

A JSON-RPC Request

{
      "method": "developer.create",
      "params": [{
            "spkey": "nzqz4xehpczjrgrjpgbwnskq",
            "properties": {
                  "first_name": "John",
                  "last_name": "Public",
                  "email": "johnqpublic@example.com",
                  "groups": ["trial"],
                  "apikey": "_auto_",
                  "secret": "_auto_",
                  "status": "active"
            }
      }]{
      "id": 1{
}

A JSON-RPC Response

{
      "result": {
            "success": true,
            "properties": {
                  "first_name": "John",
                  "last_name": "Public",
                  "email": "johnqpublic@example.com",
                  "groups": ["trial"],
                  "apikey": "_auto_",
                  "secret": "_auto_",
                  "status": "active"
            }
      }]{
      "error": null,
      "id": 1
}

Errors

This method may return one of the following errors:

Error Description
4001: Create Duplicate Email A developer with the specified email address already exists.
4002: Create Duplicate Apikey A developer with the specified API key already exists.
12: Validation Failed One or more values presented were not acceptable. Please review the documentation.
4004: Create Developer Failed Could not create a new developer record with the information provided.
4005: Create Group Failed Developer created, but could not add developer to group.

version 3 as of 2 months ago by Mashery Jeff

Comments

New comments are not being accepted at this time.