aliexpress-api-wrapper


Namealiexpress-api-wrapper JSON
Version 0.1.0 PyPI version JSON
download
home_page
Summary
upload_time2024-02-10 18:43:13
maintainer
docs_urlNone
authorMarcuth
requires_python>=3.11,<4.0
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # aliexpress-api-wrapper

A API AliExpress fornece funcionalidades para buscar produtos na plataforma AliExpress.

## Instalação

Para utilizar a API AliExpress, é necessário ter o Python instalado. Você pode instalar a API através do pip:

```bash
pip install aliexpress-api-wrapper
```

## Uso Básico

### Inicialização

Para começar a usar a API AliExpress, é necessário inicializar a classe `AliExpress`.

```python
from aliexpress_api import AliExpress

aliexpress = AliExpress(currency="USD", language="en")
```

### Métodos

#### fetch_product

Este método permite recuperar informações detalhadas sobre um produto específico. Você pode fornecer o ID do produto ou a URL do produto como entrada.

```python
product_data = aliexpress.fetch_product(id="1234567890")
```

ou

```python
product_data = aliexpress.fetch_product(url="https://www.aliexpress.com/item/1234567890.html")
```

#### search_products

Este método permite pesquisar produtos na plataforma AliExpress com base em uma consulta de pesquisa.

```python
search_results = aliexpress.search_products(query="smartphone", page_number=1)
```

## Parâmetros

### AliExpress

- `currency` (str): A moeda na qual os preços dos produtos serão exibidos. O padrão é `USD`.
- `language` (str): O idioma em que a plataforma AliExpress será exibida. O padrão é `en`.

### fetch_product

- `id` (str, opcional): O ID único do produto. Se fornecido, a URL é ignorada.
- `url` (str, opcional): A URL do produto na plataforma AliExpress. Se fornecido, o ID é ignorado.

### search_products

- `query` (str): A consulta de pesquisa para encontrar produtos na plataforma AliExpress.
- `page_number` (int, opcional): O número da página de resultados de pesquisa. O padrão é `1`.

## Retorno

Ambos os métodos `fetch_product` e `search_products` retornam um dicionário contendo informações sobre os produtos correspondentes ou os resultados da pesquisa.

## Exceções

A API pode levantar exceções em casos de falhas na comunicação com o servidor ou em situações inesperadas. Certifique-se de tratá-las adequadamente em seu código.

## Exemplo Completo

Aqui está um exemplo completo de uso da API:

```python
from minha_api_aliexpress import AliExpress

aliexpress = AliExpress(currency="USD", language="en")

product_data = aliexpress.fetch_product(id="1234567890")
print(product_data)

search_results = aliexpress.search_products(query="smartphone", page_number=1)
print(search_results)
```

Isso é tudo! Esta é a documentação básica para a API AliExpress. Sinta-se à vontade para explorar mais os métodos e personalizar conforme necessário.

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "aliexpress-api-wrapper",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Marcuth",
    "author_email": "example@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/8d/f5/43138a280a3db87c0b42e63471f6e2d11210468f584fc6a88c8ac920c450/aliexpress_api_wrapper-0.1.0.tar.gz",
    "platform": null,
    "description": "# aliexpress-api-wrapper\n\nA API AliExpress fornece funcionalidades para buscar produtos na plataforma AliExpress.\n\n## Instala\u00e7\u00e3o\n\nPara utilizar a API AliExpress, \u00e9 necess\u00e1rio ter o Python instalado. Voc\u00ea pode instalar a API atrav\u00e9s do pip:\n\n```bash\npip install aliexpress-api-wrapper\n```\n\n## Uso B\u00e1sico\n\n### Inicializa\u00e7\u00e3o\n\nPara come\u00e7ar a usar a API AliExpress, \u00e9 necess\u00e1rio inicializar a classe `AliExpress`.\n\n```python\nfrom aliexpress_api import AliExpress\n\naliexpress = AliExpress(currency=\"USD\", language=\"en\")\n```\n\n### M\u00e9todos\n\n#### fetch_product\n\nEste m\u00e9todo permite recuperar informa\u00e7\u00f5es detalhadas sobre um produto espec\u00edfico. Voc\u00ea pode fornecer o ID do produto ou a URL do produto como entrada.\n\n```python\nproduct_data = aliexpress.fetch_product(id=\"1234567890\")\n```\n\nou\n\n```python\nproduct_data = aliexpress.fetch_product(url=\"https://www.aliexpress.com/item/1234567890.html\")\n```\n\n#### search_products\n\nEste m\u00e9todo permite pesquisar produtos na plataforma AliExpress com base em uma consulta de pesquisa.\n\n```python\nsearch_results = aliexpress.search_products(query=\"smartphone\", page_number=1)\n```\n\n## Par\u00e2metros\n\n### AliExpress\n\n- `currency` (str): A moeda na qual os pre\u00e7os dos produtos ser\u00e3o exibidos. O padr\u00e3o \u00e9 `USD`.\n- `language` (str): O idioma em que a plataforma AliExpress ser\u00e1 exibida. O padr\u00e3o \u00e9 `en`.\n\n### fetch_product\n\n- `id` (str, opcional): O ID \u00fanico do produto. Se fornecido, a URL \u00e9 ignorada.\n- `url` (str, opcional): A URL do produto na plataforma AliExpress. Se fornecido, o ID \u00e9 ignorado.\n\n### search_products\n\n- `query` (str): A consulta de pesquisa para encontrar produtos na plataforma AliExpress.\n- `page_number` (int, opcional): O n\u00famero da p\u00e1gina de resultados de pesquisa. O padr\u00e3o \u00e9 `1`.\n\n## Retorno\n\nAmbos os m\u00e9todos `fetch_product` e `search_products` retornam um dicion\u00e1rio contendo informa\u00e7\u00f5es sobre os produtos correspondentes ou os resultados da pesquisa.\n\n## Exce\u00e7\u00f5es\n\nA API pode levantar exce\u00e7\u00f5es em casos de falhas na comunica\u00e7\u00e3o com o servidor ou em situa\u00e7\u00f5es inesperadas. Certifique-se de trat\u00e1-las adequadamente em seu c\u00f3digo.\n\n## Exemplo Completo\n\nAqui est\u00e1 um exemplo completo de uso da API:\n\n```python\nfrom minha_api_aliexpress import AliExpress\n\naliexpress = AliExpress(currency=\"USD\", language=\"en\")\n\nproduct_data = aliexpress.fetch_product(id=\"1234567890\")\nprint(product_data)\n\nsearch_results = aliexpress.search_products(query=\"smartphone\", page_number=1)\nprint(search_results)\n```\n\nIsso \u00e9 tudo! Esta \u00e9 a documenta\u00e7\u00e3o b\u00e1sica para a API AliExpress. Sinta-se \u00e0 vontade para explorar mais os m\u00e9todos e personalizar conforme necess\u00e1rio.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8df543138a280a3db87c0b42e63471f6e2d11210468f584fc6a88c8ac920c450",
                "md5": "341e1b8d2b0dac9930929627408a2aa3",
                "sha256": "bb60bd4b42e3eeb7c8c7f984b974f30b92ee03429b4715df2f90a0a3287248cc"
            },
            "downloads": -1,
            "filename": "aliexpress_api_wrapper-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "341e1b8d2b0dac9930929627408a2aa3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11,<4.0",
            "size": 4073,
            "upload_time": "2024-02-10T18:43:13",
            "upload_time_iso_8601": "2024-02-10T18:43:13.299549Z",
            "url": "https://files.pythonhosted.org/packages/8d/f5/43138a280a3db87c0b42e63471f6e2d11210468f584fc6a88c8ac920c450/aliexpress_api_wrapper-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-10 18:43:13",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "aliexpress-api-wrapper"
}
Marcuth
Elapsed time: 0.57948s