{"_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,"metadata":{"title":"","description":"","image":[]},"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 get API credentials. If you don't have an account yet, it's easy to sign up for one [**here**](https://sandbox.bluesnap.com/jsp/onboarding/index.jsp).\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]\nFollow these steps to get your API credentials.\n\n1. In the top menu of the BlueSnap Merchant Console, go to **Settings > API Settings**. \n    \n2. Define your API password by entering it in the **Password** and **Verify your password** fields.\n**Remember your API password; you will need it later.**\n> *Password rules*\n  * 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\n3. Complete the Authorized IPs section.  You can add up to 15 IP addresses or a subnet.  \n  * To enter a single IP addresses, enter the first IP and then click **Add** for additional addresses.\n  * To enter a range of IP addresses, enter the first IP address in the first four boxes and then add the last digits of the range in the fifth box.\n\n4. (Optional) If you want IP Checking performed, leave the **Disable IP Checking** option clear and then.  If you do **not** want IP Checking performed, select the **Disable IP Checking** option.\n> **Warnings**\n  * Do not Disable IP Checking unless absolutely necessary because it provides security to your account.\n  * Regardless of the setting of the **Disable IP Checking** option, if you add any IP addresses, you can not remove all of them.  After you add an IP address, you must always have at least one.\n\n5. Click **Request API credentials**. The credentials are generated and your new API **Username** is shown.\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]","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 get API credentials. If you don't have an account yet, it's easy to sign up for one here.

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.

Follow these steps to get your API credentials.

  1. In the top menu of the BlueSnap Merchant Console, go to Settings > API Settings.

  2. Define your API password by entering it in the Password and Verify your password fields.
    Remember your API password; you will need it later.

    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
  3. Complete the Authorized IPs section. You can add up to 15 IP addresses or a subnet.

    • To enter a single IP addresses, enter the first IP and then click Add for additional addresses.
    • To enter a range of IP addresses, enter the first IP address in the first four boxes and then add the last digits of the range in the fifth box.
  4. (Optional) If you want IP Checking performed, leave the Disable IP Checking option clear and then. If you do not want IP Checking performed, select the Disable IP Checking option.

    Warnings

    • Do not Disable IP Checking unless absolutely necessary because it provides security to your account.
    • Regardless of the setting of the Disable IP Checking option, if you add any IP addresses, you can not remove all of them. After you add an IP address, you must always have at least one.
  5. Click Request API credentials. The credentials are generated and your new API Username is shown.