---
# System prepended metadata

title: Integrações com Effective

---

# Integrações com Effective
As APIs seguem o padrão de retorno das demais APIs.

## Trazer componentes por código de produto
Esta API deve trazer informações de todos os seus componentes, incluindo subprodutos. Um produto acabado deve trazer informações dos componentes das placas eletrônicas que o compõem.


### **GET** componentes
#### Parâmetros da url
* chave: codigo
 valor: string
 descrição: código do produto solicitado
#### **COD RETORNO 200 OK**
##### Consulta válida
```json=
{
    "ApiResposta": {
        "Status": "OK"
        "Conteudo" :  {
            "ListaDeComponentes" : [
                // exemplo sub produto
                {
                    "codFamilia": ESA008_FAMILIA,
                    "familia": "TAA100_DESCRICAO",
                    "codGrupo": ESA008_GRUPOPROD,
                    "grupo": "TAA056_DESCRICAO",
                    "codSubGrupo": ESA008_SUBGRUPO,
                    "subGrupo": "TAA057_DESCRICAO",
                    "codigo": "ECB001_COMPONENTE"
                    "ListaDeComponentes": { // nivel 2
                        "codFamilia": ESA008_FAMILIA,
                        "familia": "TAA100_DESCRICAO",
                        "codGrupo": ESA008_GRUPOPROD,
                        "grupo": "TAA056_DESCRICAO",
                        "codSubGrupo": ESA008_SUBGRUPO,
                        "subGrupo": "TAA057_DESCRICAO",
                        "codigo": "ECB001_COMPONENTE"
                    }
                },
                // componente do produto
                {
                    "codFamilia": ESA008_FAMILIA,
                    "familia": "TAA100_DESCRICAO",
                    "codGrupo": ESA008_GRUPOPROD,
                    "grupo": "TAA056_DESCRICAO",
                    "codSubGrupo": ESA008_SUBGRUPO,
                    "subGrupo": "TAA057_DESCRICAO",
                    "codigo": "ECB001_COMPONENTE",
                    "local": "ECB004_LOCALIZACAO"
                }
            ]
        }
}
```
##### Consulta inválida
```json=
{
    "ApiResposta": {
        "Status": "ERRO"
    }
}
```
**COD RETORNO ERRO** 40X 50X
```javascript=
{} // conteúdo não parseado
```
## Trazer Informações de gravadores
Esta API deve trazer os modelos de gravadores utilizados para fazer a gravação de firmware.


### **GET** gravadores
#### Parâmetros da url
* chave: codigo
 valor: string
 descrição: código do produto solicitado
#### **COD RETORNO 200 OK**
##### Consulta válida
```json=
{
    "ApiResposta": {
        "Status": "OK"
        "Conteudo" :  {
            "ListaDeGravadores" : [
                {
                    "codigoModelo": "ESA025_MODELO",
                    "descricao": "TAA201_DESCRICAO"
                    "gravadores" : [
                        {
                            "codigoGravador": "TAB176_GRAVADOR",
                            "descricaoGravador": "TAB176_DESCRICAO"
                        }
                    ]
                }
            ]
        }
}
```
##### Consulta inválida
```json=
{
    "ApiResposta": {
        "Status": "ERRO"
    }
}
```
**COD RETORNO ERRO** 40X 50X
```javascript=
{} // conteúdo não parseado
```

## Campos Altium Designer

Haverão duas bibliotecas, uma de componentes e outra de circuitos, composta pelos componentes previamente criados;

- Biblioteca de Componentes:
    Os componentes serão separados em categorias seguindo por princípio as classificações utilizadas na [Digi-Key](https://www.digikey.com/en/products) e na [Octoparts](https://octopart.com/) (que foi adquirida pela Altium), seguindo por padrão a linguagem em inglês, para evitar problemas com tradução e classificação. Como segundo idioma deve ser utilizado o português para descrição secundária, ficando a descrição primária também em inglês seguindo o site ou o datasheet do componente a ser classificado. Isto para permitir uma fácil consulta de informações

- Associação de campos do altium com effective:
    
Campos na biblioteca de componentes

| Altium 365 | Effective | Observações |
| -------- | -------- | -------- |
| Picture  |  Imagem  | Nº único para correlacionar itens |
| Iten ID  | Código Effective^1^  | Text     |
| Description  | Descrição | Text     |
| Iten ID + Revision  | Logs e Alterações | Text     |
| Manufacturer Lifecycle  | Text     | Text     |
| Stock  | Text     | Text     |
| Median Price  | Text     | Text     |

Campos relacionados a parâmetros, pode variar conforme a classe do componente, não tem correlação direta com effective apesar de haver possibilidade de correlacionar alguns campos

| Altium 365 | Effective | Observações |
| -------- | -------- | -------- |
| Package Reference  | Código Effective^1^    | sdf |
| Pins  | Text     | Text     |
| Density  | Text     | Text     |
| Package Description  | Text     | Text     |
| Max Operating Tem  | Text     | Text     |
| Datasheet Version  | Text     | Text     |
| Datasheet URL  | Text     | Text     |
| Case/Package  | Text     | Text     |
| Mounting Technology  | Text     | Text     |
| Packaging  | Text     | Text     |
| Manufacturer  | Text     | Text     |
| Interface  | Text     | Text     |
| Manufacturer URL  | Text     | Text     |
| Power  | Text     | Text     |
| Max Supply Voltage  | Text     | Text     |
| Min Supply Voltage  | Text     | Text     |
| Min Operating Temperature  | Text     | Text     |
| RoHS Compliant  | Text     | Text     |
| I/Os  | Text     | Text     |
| RAM Size  | Text     | Text     |
| References Documents| Text | Text |

^1^ Deveria ser o número completo com Grupo, Família etc.

Campos na lista de materiais

| Altium 365 | Effective | Observações |
| -------- | -------- | -------- |
| Pictures Symbol and Footprint  | Text  | Text  |
| Item ID  | Text     | Text     |
| RefDesignator  | Text     | Text     |
| Quantity  | Text     | Text     |
| Name  | Text     | Text     |
| Description  | Text     | Text     |
| Class  | Text     | Text     |
| Manufacturer  | Text     | Text     |
| Manuf. Part Number  | Text     | Text     |
| Datasheet URL  | Text     | Text     |
| Lifecycle Status Indicator  | Text     | Text     |
| Technical Parameter  | Text     | Text     |

