Skip to content

Commit cb0d67a

Browse files
committed
chore: README.md update
1 parent cd48fe9 commit cb0d67a

File tree

156 files changed

+159
-196
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

156 files changed

+159
-196
lines changed

README.md

Lines changed: 3 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,7 @@
11
# Hostinger API PHP SDK
22

3-
> [!caution]
4-
> Currently, this API is in beta stage, meaning that breaking changes, while unlikely, might be introduced.
5-
> If you encounter any issues or have any feedback, please create an issue on the [Github Repository](https://github.com/hostinger/api/issues).
6-
# Overview
7-
The Hostinger API provides a comprehensive set of endpoints that allow developers to interact with Hostinger's services programmatically.
8-
This API enables you to manage various aspects of your Hostinger account.
9-
10-
The Hostinger API is a (mostly) RESTful API that uses standard HTTP methods and status codes.
11-
# Authentication
12-
The Hostinger API uses tokens for authentication. To authenticate your requests, you need to include a valid bearer token in the Authorization header of your HTTP requests:
13-
```yaml
14-
Authorization: Bearer YOUR_API_TOKEN
15-
```
16-
API tokens for individual users can be created and managed from the [VPS page](https://hpanel.hostinger.com/vps) of the Hostinger Panel.
17-
Tokens will have same permissions as the owning user. Optionally, tokens can be set to expire after a certain period of time.
18-
# Rate Limiting
19-
To ensure fair usage and prevent abuse, the API enforces rate limits on the number of requests that can be made within a certain time period.
20-
If you exceed the rate limit, you will receive a 429 Too Many Requests response. Rate limit headers are included in the response to help you manage your requests.
21-
Your IP address might get temporarily blocked if you exceed the rate limit multiple times.
22-
# Parameters
23-
All requests sent to API must have the content type `application/json`. `POST`, `PUT`, `PATCH` methods may include a JSON object in the request body. Documentation provides required structure and examples of the object.
24-
Some endpoints require path parameters. These parameters are included in the URL path and are marked with curly braces.
25-
# Pagination
26-
Some endpoints return a large number of items. To make these responses more manageable, the API uses pagination.
27-
By default, the API returns 50 items per page.
28-
29-
The page number can be specified using the `page` query parameter, for example: `/api/vps/v1/public-keys?page=2`
30-
# Errors
31-
The Hostinger API uses standard HTTP status codes to indicate the success or failure of a request.
32-
In case of an error, the API will return a JSON response with an `error` field, containing a human-readable error message.
33-
Error responses also contain a `correlation_id` field which can be used to identify the request in case you need to contact support.
34-
# Change log
35-
For information on the latest changes to the API, please refer to the [change log](https://github.com/hostinger/api/blob/main/CHANGELOG.md).
36-
# Support
37-
If you have any questions, feedback or feature requests, please create an [issue](https://github.com/hostinger/api/issues) or [discussion](https://github.com/hostinger/api/discussions) on the repository.
38-
39-
For any support take a look at our [Github Repository](https://github.com/hostinger/api/), dedicated to the Hostinger API.
40-
41-
For more information, please visit [https://www.hostinger.com](https://www.hostinger.com).
3+
## About
4+
This is a Python SDK for the Hostinger API. For more information, please visit [https://developers.hostinger.com](https://developers.hostinger.com).
425

436
## Installation & Usage
447

@@ -59,7 +22,7 @@ To install the bindings via [Composer](https://getcomposer.org/), add the follow
5922
}
6023
],
6124
"require": {
62-
"hostinger/api-php-sdk": "dev-main"
25+
"hostinger/api-php-sdk": "*"
6326
}
6427
}
6528
```

src/Api/BillingCatalogApi.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/**
44
* Hostinger API PHP SDK
55
*
6-
* API Version: 0.0.1-beta
6+
* API Version: 0.0.5
77
* @url https://github.com/hostinger/api-php-sdk
88
*
99
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!

src/Api/BillingOrdersApi.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/**
44
* Hostinger API PHP SDK
55
*
6-
* API Version: 0.0.1-beta
6+
* API Version: 0.0.5
77
* @url https://github.com/hostinger/api-php-sdk
88
*
99
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!

src/Api/BillingPaymentMethodsApi.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/**
44
* Hostinger API PHP SDK
55
*
6-
* API Version: 0.0.1-beta
6+
* API Version: 0.0.5
77
* @url https://github.com/hostinger/api-php-sdk
88
*
99
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!

src/Api/BillingSubscriptionsApi.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/**
44
* Hostinger API PHP SDK
55
*
6-
* API Version: 0.0.1-beta
6+
* API Version: 0.0.5
77
* @url https://github.com/hostinger/api-php-sdk
88
*
99
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!

src/Api/DomainsPortfolioApi.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/**
44
* Hostinger API PHP SDK
55
*
6-
* API Version: 0.0.1-beta
6+
* API Version: 0.0.5
77
* @url https://github.com/hostinger/api-php-sdk
88
*
99
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!

src/Api/VPSActionsApi.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/**
44
* Hostinger API PHP SDK
55
*
6-
* API Version: 0.0.1-beta
6+
* API Version: 0.0.5
77
* @url https://github.com/hostinger/api-php-sdk
88
*
99
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!

src/Api/VPSBackupsApi.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/**
44
* Hostinger API PHP SDK
55
*
6-
* API Version: 0.0.1-beta
6+
* API Version: 0.0.5
77
* @url https://github.com/hostinger/api-php-sdk
88
*
99
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!

src/Api/VPSDataCentersApi.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/**
44
* Hostinger API PHP SDK
55
*
6-
* API Version: 0.0.1-beta
6+
* API Version: 0.0.5
77
* @url https://github.com/hostinger/api-php-sdk
88
*
99
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!

src/Api/VPSFirewallApi.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/**
44
* Hostinger API PHP SDK
55
*
6-
* API Version: 0.0.1-beta
6+
* API Version: 0.0.5
77
* @url https://github.com/hostinger/api-php-sdk
88
*
99
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!

0 commit comments

Comments
 (0)