The Biznesi Im API provides a powerful tool for accessing business data within our application. By utilizing an API key for authentication, users can retrieve detailed information about registered businesses, ensuring secure and efficient data access.
\nKey features of the API include:
\nData Access: Retrieve essential business data, including company details, contact information, and ownership structure.
\nFast & Reliable: Optimized for performance, the API ensures rapid data retrieval, making it ideal for applications requiring real-time access.
\nSecure Integration: The API employs secure authentication via API keys, protecting sensitive business information.
\nEasy to Use: With clear and structured endpoints, businesses can be found quickly and effortlessly, simplifying the process of managing and accessing business data.
\nThis API enhances data discovery and management for businesses, empowering users to integrate business information seamlessly into their systems.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"}],"owner":"38452043","collectionId":"12dab9c6-a213-4d2b-a0c1-557f5305570c","publishedId":"2sAXxS7BT6","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-11T12:39:13.000Z"},"item":[{"name":"Authentication","item":[],"id":"c1adef45-b75e-4cf6-98e0-bfc76d2b0d34","description":"To use the Biznesi Im API, each request must include an API Key for authentication. Without a valid API Key, requests will be denied.
\n\n\nPlease contact us at office@xpertt.net to get access to API testing environment
\n
API Key: Generated within the Biznesi Im application.
\nHeader: Add the API Key to each request's header:
\nHeader Name: X-Api-Key
Header Value: {API_KEY}
GET /api/business/getbusiness HTTP/1.1\nHost: biznesiim.com\nX-Api-Key: {API_KEY}\n\n401 Unauthorized: Requests without a valid API Key will receive this error.
\n403 Forbidden: If the request comes from outside the server's domain and the X-Swagger-Request header is not found, the response will return a 403 status with the following error message:
{\n \"error\": \"Access denied. The element 'X-Swagger-Request' could not be found. Please refer to our documentation for further details.\"\n}\n\nThis endpoint fetches a paginated list of all registered businesses. It supports query parameters for pagination to retrieve businesses in chunks.
\n\n\nAPI return status code 200,400,404,500
\n
\n\nSuccess response
\n
{\n \"data\": [\n {\n \"businessName\": \"string\",\n \"tradeName\": \"string\",\n \"businessType\": \"string\",\n \"uniqueBusinessId\": \"number\",\n \"businessNumber\": \"number\",\n \"fiscalNumber\": \"number\",\n \"numberOfEmployees\": \"number\",\n \"registrationDate\": \"date\",\n \"municipality\": \"string\",\n \"address\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\",\n \"capital\": \"number\",\n \"arbK_Status\": \"boolean\",\n \"_Activities\": [\n {\n \"activityId\": \"number\",\n \"businessId\": \"number\",\n \"activityCode\": \"number\",\n \"activityDescription\": \"string\",\n \"activityType\": \"string\"\n }\n ],\n \"_AuthorizedRepresentatives\": [\n {\n \"authorizedRepresentativeId\": \"number\",\n \"businessId\": \"number\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"businessPosition\": \"string\",\n \"authorization\": \"string\"\n }\n ],\n \"_OwnershipEntities\": [\n {\n \"ownershipEntityId\": \"number\",\n \"businessId\": \"number\",\n \"fullName\": \"string\",\n \"gender\": \"string\",\n \"capitalInEuro\": \"number\",\n \"capitalInPercentage\": \"number\"\n }\n ],\n \"_Units\": [\n {\n \"unitId\": \"number\",\n \"businessId\": \"number\",\n \"unitNumber\": \"number\",\n \"unitName\": \"string\",\n \"unitCode\": \"number\",\n \"unitPlace\": \"string\"\n }\n ]\n }\n ],\n \"succeeded\": true,\n \"message\": \"Operation completed successfully\",\n \"status\": 200\n}\n\n\n\nThe requested business or data was not found.
\n
{\n \"data\": null,\n \"succeeded\": false,\n \"message\": \"Business not found\",\n \"status\": 404\n}\n\n\n\nAn error occurred on the server while processing the request.
\n
{\n \"data\": null,\n \"succeeded\": false,\n \"message\": \"An error occurred while fetching data\",\n \"status\": 500\n}\n\nThis endpoint allows you to search for businesses using a unique identifier. It supports pagination and returns a paginated list of matching businesses.
\n\n\nAPI return status code 200,400,500
\n
\n\nSuccess response
\n
{\n \"data\": [\n {\n \"businessName\": \"string\",\n \"tradeName\": \"string\",\n \"businessType\": \"string\",\n \"uniqueBusinessId\": \"number\",\n \"businessNumber\": \"number\",\n \"fiscalNumber\": \"number\",\n \"numberOfEmployees\": \"number\",\n \"registrationDate\": \"date\",\n \"municipality\": \"string\",\n \"address\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\",\n \"capital\": \"number\",\n \"arbK_Status\": \"boolean\",\n \"_Activities\": [\n {\n \"activityId\": \"number\",\n \"businessId\": \"number\",\n \"activityCode\": \"number\",\n \"activityDescription\": \"string\",\n \"activityType\": \"string\"\n }\n ],\n \"_AuthorizedRepresentatives\": [\n {\n \"authorizedRepresentativeId\": \"number\",\n \"businessId\": \"number\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"businessPosition\": \"string\",\n \"authorization\": \"string\"\n }\n ],\n \"_OwnershipEntities\": [\n {\n \"ownershipEntityId\": \"number\",\n \"businessId\": \"number\",\n \"fullName\": \"string\",\n \"gender\": \"string\",\n \"capitalInEuro\": \"number\",\n \"capitalInPercentage\": \"number\"\n }\n ],\n \"_Units\": [\n {\n \"unitId\": \"number\",\n \"businessId\": \"number\",\n \"unitNumber\": \"number\",\n \"unitName\": \"string\",\n \"unitCode\": \"number\",\n \"unitPlace\": \"string\"\n }\n ]\n }\n ],\n \"succeeded\": true,\n \"message\": \"Operation completed successfully\",\n \"status\": 200\n}\n\n\n\nThe requested business or data was not found.
\n
{\n \"data\": null,\n \"succeeded\": false,\n \"message\": \"Business not found\",\n \"status\": 404\n}\n\n\n\nAn error occurred on the server while processing the request.
\n
{\n \"data\": null,\n \"succeeded\": false,\n \"message\": \"An error occurred while fetching data\",\n \"status\": 500\n}\n\nThe API endpoints handle requests for managing business data, including fetching and searching businesses. Key features include:
\nGET /api/Business/getbusiness: Retrieves a paginated list of businesses with details like representatives and activities.
\nGET /api/Business/search: Searches for businesses by their unique ID with pagination support.
\nEach endpoint returns structured data using the OperationResult format for consistent responses and error handling.
page, pageSize\n\nFirst scenario -> geting all Data with pagination
\n
\n\n","_postman_id":"a0a0531d-d030-4692-821a-20afe6060701"},{"name":"Testing & Variables","item":[],"id":"9fcdcd16-cd08-4d7e-872b-396ff084338e","description":"Second scenario -> searching data with
\nuniqueId
Environment-specific configurations and reusable variables are defined to streamline API request testing, allowing seamless transitions between environments such as Development and Production.
\nbase_url: Defines the root API URL, simplifying updates when switching between environments.
\nAPI Key: Holds the authentication token required for secure access to the API.
\nuniqueId: Dynamically represents the unique identifier for a business entity, ensuring accurate data retrieval.
\npage: Specifies the current page number for paginated API responses.
\npageSize: Determines the number of items to be retrieved per page in API responses.
\nThis approach centralizes the handling of dynamic values, ensuring that API requests adapt automatically to changes in environment or configuration, enhancing the overall efficiency of testing.
\n","_postman_id":"9fcdcd16-cd08-4d7e-872b-396ff084338e"},{"name":"Response Api Key Errors","item":[],"id":"8c063c9d-0d97-49b6-8987-7bc6a23e2627","description":"The API implements several validation checks and rate-limiting mechanisms to ensure security and proper usage. Below are the potential errors that may be encountered during API requests, and the corresponding HTTP status codes and error messages.
\nStatus Code 403 Forbidden - Missing or Invalid Swagger Request
\n\n\nCondition: When the request does not originate from the server's domain, and the
\nX-Swagger-Requestheader is missing or incorrect.
{\n \"error\": \"Access denied. The element 'X-Swagger-Request' could not be found. Please refer to our documentation for further details.\"\n}\n\nStatus Code 401 Unauthorized - Missing API Key
\n\n\nCondition: When the
\nX-Api-Keyheader is missing or not provided in the request.
{\n \"error\": \"API key is missing or invalid.\"\n}\n\nStatus Code 401 Unauthorized - Invalid API Key
\n\n\nCondition: When the provided API key is not found or is inactive in the database.
\n
{\n \"error\": \"Unauthorized client.\"\n}\n\nStatus Code 403 Forbidden - Demo User Access Denied
\n\n\nCondition: If the API key belongs to a user marked as
\nDemoUser, access to the API is restricted.
{\n \"error\": \"Access denied. Demo users are not allowed to use this API. Please create a real account and try again with valid credentials.\"\n}\n\nStatus Code 429 Too Many Requests - Rate Limit Exceeded
\n\n\nCondition: When the API key is Free Plan and exceeds the allowed rate limit within a time window.
\n
{\n \"error\": \"Rate limit exceeded. Try again later.\"\n}\n\nStatus Code 403 Forbidden - API Usage Limit Exceeded
\n\n\nCondition: If the user has exceeded their subscription's allowed API usage.
\n
{\n \"error\": \"API usage limit exceeded. You have reached the maximum allowed usage for your subscription.\"\n}\n\nStatus Code 500 Internal Server Error - General Exception
\n\n\nCondition: If an internal error occurs during API request processing.
\n
{\n \"error\": \"An internal server error occurred: {Exception Message}\"\n}\n\n