{"_id":"5bc48b4f9919d4000df5ea40","category":{"_id":"5bc48b4f9919d4000df5ea34","version":"5bc48b4f9919d4000df5ea7b","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-04-21T12:52:47.551Z","from_sync":false,"order":1,"slug":"reporting-api","title":"Reporting API"},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5bc48b4f9919d4000df5ea7b","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5b8ec64c7ef0f4000350182a","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z","categories":["5bc48b4f9919d4000df5ea33","5bc48b4f9919d4000df5ea34","5bc48b4f9919d4000df5ea35","5bc48b4f9919d4000df5ea36","5bc48b4f9919d4000df5ea37","5bc48b4f9919d4000df5ea38","5bc48b4f9919d4000df5ea39","5bc48b4f9919d4000df5ea3a","5bc48b4f9919d4000df5ea3b","5bc48b4f9919d4000df5ea3c","5bc48b4f9919d4000df5ea3d","5bc48b4f9919d4000df5ea3e","5b34c737e0dca2000311de6a","5bc48b4f9919d4000df5ea3f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.27.1 Release","version_clean":"8976.0.0-Tools","version":"8976-Tools"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-06T17:30:48.697Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"The BlueSnap Reporting API is a RESTful web service that enables you to retrieve report data and parse it according to your needs.\n\n##API URL\nThese are the Reporting API URLs for the BlueSnap environments:\n* Sandbox: `https://sandbox.bluesnap.com/services/2/report/{report_code}?{parameters}`\n* Production: `https://ws.bluesnap.com/services/2/report/{report_code}?{parameters}`\n\n##GET Request & Response Format\nTo obtain the report data, you will send a GET request with the report code and relevant parameters. The response will be provided in either JSON or CSV format, per your request. Paging is supported.\n\n:fa-arrow-circle-right: For details about the request and response, see [GET Report Data](doc:get-report-data).\n\n:fa-arrow-circle-right: For information about possible errors, see [Errors](doc:reporting-api-errors).\n\n##Authentication\nEvery API request must be authenticated using a HTTP Basic Authentication header, as follows:\n`Authorization: Basic {Base64 encoding of 'username:password'}`\nFor example:\n`Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=`\n\nYour API username and password can be found in the Merchant Console, under **Settings > API Settings**. You will need different API credentials for the Sandbox and Production environments.\n\n##API Credentials\nIf you do not yet have API credentials, follow these steps to obtain them:\n1. In the BlueSnap Merchant Console, log in to your <a href=\"https://sandbox.bluesnap.com/jsp/developer_login.jsp\" target=\"_blank\">Sandbox</a> or <a href=\"https://admin.bluesnap.com/jsp/developer_login.jsp?app1=Y\" target=\"_blank\">Production</a> account.\n2. Go to **Settings > API Settings**. \n3. Define your API password by entering it in the **Password** and **Verify your password** fields.\n4. 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.\n5. Click **Request API credentials**. \n    The credentials are generated and your new API username is displayed.\n    \n**Note:** You will need a BlueSnap account in order to get API credentials. If you don't have an account yet, you can [sign up for one here](http://home.bluesnap.com/get-started/).","excerpt":"","slug":"reporting-api-overview","type":"basic","title":"Reporting API Overview"}

Reporting API Overview


The BlueSnap Reporting API is a RESTful web service that enables you to retrieve report data and parse it according to your needs.

API URL

These are the Reporting API URLs for the BlueSnap environments:

  • Sandbox: https://sandbox.bluesnap.com/services/2/report/{report_code}?{parameters}
  • Production: https://ws.bluesnap.com/services/2/report/{report_code}?{parameters}

GET Request & Response Format

To obtain the report data, you will send a GET request with the report code and relevant parameters. The response will be provided in either JSON or CSV format, per your request. Paging is supported.

For details about the request and response, see GET Report Data.

For information about possible errors, see Errors.

Authentication

Every API request must be authenticated using a HTTP Basic Authentication header, as follows:
Authorization: Basic {Base64 encoding of 'username:password'}
For example:
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Your API username and password can be found in the Merchant Console, under Settings > API Settings. You will need different API credentials for the Sandbox and Production environments.

API Credentials

If you do not yet have API credentials, follow these steps to obtain them:

  1. In the BlueSnap Merchant Console, log in to your Sandbox or Production account.
  2. Go to Settings > API Settings.
  3. Define your API password by entering it in the Password and Verify your password fields.
  4. 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.
  5. Click Request API credentials.
    The credentials are generated and your new API username is displayed.

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