Bitdefender Connector

Documentation

Base Url

Get Subscriber

v1

http://lzrconnector-bitdefender.lazarustechservices.com/v1/get-subscriber

• Method: POST
• URL: /v1/get-subscriber
• Description: Returns subscriber data
• Body:

  
              {
                  "email": "string",
                  "businessKey": "api key bitdefender organization"
              }
          

• Response: JSON

Response

Returns a JSON with the information about the subscription by email.
Successful response:

Subscriber without subscription

        {
            "status": "success",
            "data": {
                "count": number,
                "subscribers": [],
                "query_hash": "..."
            },
            "links": {
                "self": "/v1/get-subscriber",
                "suscriber": "/v1/add-subscriber"
            }
        }
    

Subscriber with subscription

        {
            "status": "success",
            "data": [ 
                {
                    "subscriber_id": "...",
                    "email": "...",
                    "phone": "",
                    "username": "",
                    "external_subscriber_id": "",
                    "state": "active",
                    "created": ...,
                    "last_updated": ...,
                    "subscriptions": [
                        {
                            "product_id": "bitdefender-is-5device",
                            "subscription_id": "...",
                            "state": "active"
                        }
                    ]
                }
            ],
            "links": {
                "self": "/v1/get-subscriber",
                "suscriber": "/v1/add-subscriber"
            }
        }
    

Error

Return error message

{
        "status": "error",
        "message": "error message",
        
    }
    

Add Subscriber

v1

http://lzrconnector-bitdefender.lazarustechservices.com/v1/add-subscriber

• Method: POST
• URL: /v1/add-subscriber
• Description: Returns subscriber id
• Body:

  
              {
                  "email": "string",
                  "businessKey": "api key bitdefender organization"
              }
          

• Response: JSON

Response

Returns a JSON with the information about the subscription by email.
Successful response:

        {
    "status": "success",
    "data": {
        "enrol_url": "string",
        "subscriber_id": "string"
    },
    "links": {
        "self": "/v1/add-subscriber",
        "suscriber": "/v1/get-subscriber"
    }
}
    

Error

Return error message

{
        "status": "error",
        "message": "error message",
        
    }
    

Delete Subscriber

v1

http://lzrconnector-bitdefender.lazarustechservices.com/v1/delete-subscriber

• Method: DELETE
• URL: /v1/delete-subscriber
• Description: Returns json status
• Body:

  
              {
                  "businessKey": "",
                  "subscriberId": ""
              }
          

• Response: JSON

Response

Returns a JSON with status.
Successful response:

        {
            "status": "success",
            "data": {
                "status": 0
            },
            "links": {
                "self": "/v1/delete-subscriber",
                "suscriber": "/v1/get-subscriber"
            }
        }
    

Error

Return error message

{
        "status": "error",
        "message": "error message",
        
    }
    

Add Subscription

v1

http://lzrconnector-bitdefender.lazarustechservices.com/v1/add-subscription

• Method: POST
• URL: "/v1/add-subscription
• Description: Return subscription Id
• Body:

  
              {
                  "businessKey": "",
                  "subscriberId": "",
                  "productId": ""
              }
          

• Response: JSON

Response

Returns a JSON with susbcription Id.
Successful response:

        {
            "status": "success",
            "data": {
                "subscription_id": "string"
            },
            "links": {
                "self": "/v1/add-subscription",
                "delete": "/v1/delete-subscription"
            }
        }
    

Error

Return error message

{
        "status": "error",
        "message": "error message",
        
    }
    

Delete Subscription

v1

http://lzrconnector-bitdefender.lazarustechservices.com/v1/delete-subscription

• Method: DELETE
• URL: "/v1/delete-subscription
• Description: Return status
• Body:

  
              {
                  "businessKey": "",
                  "subscriberId": "",
                  "subscriptionId": ""
              }
          

• Response: JSON

Response

Returns a JSON with status.
Successful response:

        {
            "status": "success",
            "data": {
                "status": 0
            },
            "links": {
                "self": "/v1/delete-subscription",
                "add": "/v1/add-subscription",
                "get": "/v1/get-all_products-id"
            }
        }
    

Error

Return error message

{
        "status": "error",
        "message": "error message",
        
    }
    

Get all products id

v1

http://lzrconnector-bitdefender.lazarustechservices.com/v1/get-all-products-id

• Method: GET
• URL: "/v1/get-all-products-id
• Description: Return array of avaiable products
• Response: JSON

Response

Returns a JSON with array products.
Successful response:

        {
            "status": "success",
            "data": [
                "bitdefender-av-10device",
                "bitdefender-av-1device",
                "bitdefender-av-3device",
                "bitdefender-av-5device",
                "bitdefender-avformac-1device",
                "bitdefender-avformac-3device",
                "bitdefender-bms-1device",
                "bitdefender-fp-15device",
                "bitdefender-is-10device",
                "bitdefender-is-1device",
                "bitdefender-is-3device",
                "bitdefender-is-5device",
                "bitdefender-tsmd-10device",
                "bitdefender-tsmd-3device",
                "bitdefender-tsmd-5device"
            ],
            "links": {
                "self": "/v1/get-all-products-id",
                "add": "/v1/add-subscription",
                "delete": "/v1/delete-subscription"
            }
        }
    

Error

Return error message

{
        "status": "error",
        "message": "error message",
        
    }