Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kzrtt/php_geocode
Esta API fornece serviços de geolocalização
https://github.com/kzrtt/php_geocode
Last synced: 10 days ago
JSON representation
Esta API fornece serviços de geolocalização
- Host: GitHub
- URL: https://github.com/kzrtt/php_geocode
- Owner: Kzrtt
- Created: 2024-04-02T19:04:56.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-02T20:01:09.000Z (10 months ago)
- Last Synced: 2024-11-18T06:19:14.231Z (2 months ago)
- Language: PHP
- Size: 4.88 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Documentação da API de Geolocalização
Esta API fornece serviços de geolocalização, permitindo que usuários obtenham endereços a partir de coordenadas geográficas (latitude e longitude) e vice-versa. Utiliza a API do Google Maps Geocoding para realizar as operações. Abaixo estão detalhados os métodos disponíveis e como utilizá-los.
## Métodos Disponíveis
### 1. Obter Endereço (`getAddress`)
Converte coordenadas geográficas (latitude e longitude) em um endereço postal.
#### Requisição:
- **Tipo:** `POST`
- **Corpo da requisição (JSON):**
```json
{
"action": "getAddress",
"lat": "",
"lng": ""
}
```
- **Parâmetros:**
- `lat`: Latitude da localização.
- `lng`: Longitude da localização.
#### Resposta:
- **Tipo:** `application/json`
- **Corpo da resposta (JSON):**
```json
{
"status": true|false,
"data": {
"address": ""
},
"message": "Endereço retornado com sucesso"|"Erro ao retornar endereço"
}
```
### 2. Obter Coordenadas (`getCoordinates`)
Converte um endereço postal em coordenadas geográficas (latitude e longitude).
#### Requisição:
- **Tipo:** `POST`
- **Corpo da requisição (JSON):**
```json
{
"action": "getCoordinates",
"street": "",
"number": "",
"city": "",
"state": "",
"postalCode": ""
}
```
- **Parâmetros:**
- `street` (opcional): Nome da rua.
- `number` (opcional): Número do endereço na rua.
- `city` (opcional): Cidade do endereço.
- `state` (opcional): Sigla do estado. Use as siglas brasileiras, como "SP" para São Paulo.
- `postalCode` (opcional): Código Postal (CEP) do endereço.
#### Resposta:
- **Tipo:** `application/json`
- **Corpo da resposta (JSON):**
```json
{
"status": true|false,
"data": {
"lat": ,
"lng":
},
"message": "Coordenadas retornadas com sucesso"|"Erro ao retornar coordenadas"
}
```