Addressbook/Info

Introduction

The Address Book API provides endpoints for managing and retrieving information about contacts. This document outlines the details for the /api/Addressbook/Info endpoint, which allows you to get information about an AddressBook item using a username, email, or mobile number.

• Base URL: https://api.addressbook.com/v1

Authentication

To access the API, you must authenticate using an API key.

Authentication Method

Include your API key in the Authorization header of your requests.

• Header: Authorization: Bearer YOUR_API_KEY

Example Request

curl -H "Authorization: Bearer YOUR_API_KEY" 
-H "x-api-version: 1.0" "https://api.addressbook.com/v1/api/Addressbook/Info?value=johndoe"

Endpoint

• URL: /api/Addressbook/Info
• Method: GET
• Description: Retrieve information about an AddressBook item by providing a username, email, or mobile number.

Parameters

Query Parameters

• value (string, required): Enter the username, email, or mobile number of the contact you are searching for.

Header Parameters

• x-api-version (string, required): Specify the API version.

Try It Out

You can test this endpoint using the following command:

curl -X 'GET' \
  'https://wallet.xprizo.com/api/Addressbook/Info?value=John%20Doe' \
  -H 'accept: text/plain' \
  -H 'x-api-version: 1'

Responses

200 Success

Description: The request was successful, and the information about the AddressBook item is returned.

• Media Type: text/plain
• Example Value:

  {
    "id": 0,
    "description": "string"
  }

400 Bad Request

Description: The request could not be understood or was missing required parameters.

• Media Type: text/plain
• Example Value:

  {
    "timestamp": "2024-05-27T07:27:12.600Z",
    "statusCode": 0,
    "status": "string",
    "errorCode": 0,
    "message": "string"
  }

401 Unauthorized

Description: Authentication failed or the user does not have permission for the requested operation.

• Media Type: text/plain
• Example Value:

  {
    "type": "string",
    "title": "string",
    "status": 0,
    "detail": "string",
    "instance": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }

500 Server Error

Description: An error occurred on the server.

• Media Type: text/plain
• Example Value:

  {
    "timestamp": "2024-05-27T07:27:12.603Z",
    "statusCode": 0,
    "status": "string",
    "errorCode": 0,
    "message": "string"
  }