{"_id":"59bc55d82b480b0010010ccf","category":{"_id":"59bc55d72b480b0010010c94","version":"59bc55d72b480b0010010c92","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-01T16:42:25.324Z","from_sync":false,"order":1,"slug":"payment-api-essentials","title":"API Usage"},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"_id":"59bc55d72b480b0010010c92","project":"57336fd5a6a9c40e00e13a0b","__v":2,"createdAt":"2017-09-15T22:36:07.078Z","releaseDate":"2017-09-15T22:36:07.078Z","categories":["59bc55d72b480b0010010c93","59bc55d72b480b0010010c94","59bc55d72b480b0010010c95","59bc55d72b480b0010010c96","59bc55d72b480b0010010c97","59bc55d72b480b0010010c98","59bc55d72b480b0010010c99","59cd3e7c210d1900326834b1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"3.22.2 Release","version_clean":"8976.0.0-Basics","version":"8976-Basics"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-06T17:23:30.113Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"You will need a BlueSnap account in order to obtain API credentials. If you don't have an account yet, you can [sign up for one here](http://home.bluesnap.com/get-started/).\n\nFollow these steps to get your API credentials:\n\n1. Go to **Settings > API Settings** in the top menu of the BlueSnap Merchant Console. \n    \n2. Define your API password by entering it in the **Password** and **Verify your password** fields.\n    <img src=\"https://files.readme.io/zwKzE54Tci1YiZcLq1Ac_APIcredentials.png\">\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Password rules\",\n  \"body\": \"* Minimum of 7 characters (no maximum character limit)\\n* Allowed characters: a-z A-Z 0-9 _~!:::at:::#&$%^*()|'-\\n* One capital letter and one number\\n* Start with a letter\\n* Should not contain consecutive characters\\n\\nImportant: Remember your API Password for later\"\n}\n[/block]\n3. In the **New IP Address** field, enter the IP address to be used for API calls. You can add up to fifteen IP addresses or a subnet.\n    <img src=\"https://files.readme.io/z7yuSQ7eTmuPLQf2MVem_AuthIPs.png\">\n    \n4. Click **Request API credentials**. The credentials are generated and your new API **Username **is displayed.\n    <img src=\"https://files.readme.io/Ofqqpw2QLC5N8TXN3Wob_API_username.png\">\n    \n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"You'll include your BlueSnap API username and password in the Basic Authentication header when you make calls to our API. For more info, see [Authentication & Headers](doc:authentication).\",\n  \"title\": \"API credentials in the HTTP Basic Authentication header\"\n}\n[/block]","excerpt":"How to get your BlueSnap API credentials","slug":"api-credentials","type":"basic","title":"API Credentials"}

API Credentials

How to get your BlueSnap API credentials

You will need a BlueSnap account in order to obtain API credentials. If you don't have an account yet, you can sign up for one here.

Follow these steps to get your API credentials:

  1. Go to Settings > API Settings in the top menu of the BlueSnap Merchant Console.

  2. Define your API password by entering it in the Password and Verify your password fields.

Password rules

  • Minimum of 7 characters (no maximum character limit)
  • Allowed characters: a-z A-Z 0-9 _~!@#&$%^*()|'-
  • One capital letter and one number
  • Start with a letter
  • Should not contain consecutive characters

Important: Remember your API Password for later

  1. In the New IP Address field, enter the IP address to be used for API calls. You can add up to fifteen IP addresses or a subnet.

  2. Click Request API credentials. The credentials are generated and your new API Username is displayed.

API credentials in the HTTP Basic Authentication header

You'll include your BlueSnap API username and password in the Basic Authentication header when you make calls to our API. For more info, see Authentication & Headers.