{"_id":"5c6c238ff7d5480039535596","category":{"_id":"5c6c238ff7d548003953555e","version":"5c6c238ff7d54800395355a0","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":"5c6c238ff7d54800395355a0","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"5beb278ac442ab0213f009cf","createdAt":"2018-04-23T14:36:48.535Z","releaseDate":"2018-04-23T14:36:48.535Z","categories":["5c6c238ff7d548003953555d","5c6c238ff7d548003953555e","5c6c238ff7d548003953555f","5c6c238ff7d5480039535560","5c6c238ff7d5480039535561","5c6c238ff7d5480039535562","5beb278ac442ab0213f00990","5c6c238ff7d5480039535563","5c3f542c12c4ac004bc51718","5c928dba4aa821001ae4f050"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Main","version_clean":"8976.0.0-Basics","version":"8976-Basics"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-06T17:23:30.113Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"You must have a BlueSnap account to obtain API credentials. If you don't have an account yet it is easy to [sign up for one here](http://home.bluesnap.com/get-started/).\n\nFollow these steps to get your API credentials:\n\nStep 1. Go to **Settings > API Settings** in the top menu of the BlueSnap Merchant Console. \n    \nStep 2. Define your API password by entering it in the **Password** and **Verify your password** fields.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ae9913c-api_credentials.PNG\",\n        \"api_credentials.PNG\",\n        652,\n        141,\n        \"#f6f6f6\"\n      ]\n    }\n  ]\n}\n[/block]\n\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* Must begin with a letter\\n* Should not contain consecutive characters\\n\\n**Important!** \\n     Remember your API Password for later.\"\n}\n[/block]\nStep 3. 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[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/401ac05-authorized_ips.PNG\",\n        \"authorized_ips.PNG\",\n        598,\n        145,\n        \"#f7f7f6\"\n      ]\n    }\n  ]\n}\n[/block]\nStep 4. (Optional) If necessary, you can disable IP checking on your account.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Warning\",\n  \"body\": \"Do not Disable IP Checking unless absolutely necessary because it provides security to your account.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/f66e02e-disable_IP_checking.PNG\",\n        \"disable_IP_checking.PNG\",\n        735,\n        121,\n        \"#353739\"\n      ]\n    }\n  ]\n}\n[/block]\nStep 5. Click **Request API credentials**. The credentials are generated and your new API **Username** is displayed.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d06b87b-API_username.png\",\n        \"API_username.png\",\n        474,\n        109,\n        \"#f2f2f2\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"You include your BlueSnap API username and password in the Basic Authentication header when you make calls to our API. For more information, refer to [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 must have a BlueSnap account to obtain API credentials. If you don't have an account yet it is easy to sign up for one here.

Follow these steps to get your API credentials:

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

Step 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
  • Must begin with a letter
  • Should not contain consecutive characters

Important!
     Remember your API Password for later.

Step 3. 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.

Step 4. (Optional) If necessary, you can disable IP checking on your account.

Warning

Do not Disable IP Checking unless absolutely necessary because it provides security to your account.

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

API credentials in the HTTP Basic Authentication header

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