{"openapi":"3.1.0","info":{"title":"Agimpe Integration API","description":"API por empresa para integrações entre servidores. Use Authorization: Bearer <api_key>. Limite compartilhado de 60 requisições/minuto por empresa. Chaves são geradas na área Integrações. Matches representam relevância de monitoramento, não confirmação de obrigação. Alterações do perfil usam controle de revisão. Erros: 401 credencial inválida, 403 escopo insuficiente, 404 recurso indisponível, 409 conflito de revisão, 422 validação, 429 limite de uso.","version":"1.0.0"},"paths":{"/company":{"get":{"tags":["Company"],"summary":"Company","description":"Return the single company authorized by this credential.","operationId":"company_company_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyOut"}}}}},"security":[{"AgimpeApiKey":[]}]}},"/operation-profile":{"get":{"tags":["Operation"],"summary":"Operation","operationId":"operation_operation_profile_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationOut"}}}}},"security":[{"AgimpeApiKey":[]}]},"put":{"tags":["Operation"],"summary":"Save Operation","description":"Replace the full operational profile. All list fields are replacements, not patches.\n\nRead the current revision first; use expected_revision=0 if no profile exists.\nA repeated identical request with an old revision returns 409; read before retrying.","operationId":"save_operation_operation_profile_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationOut"}}}},"409":{"description":"Revision changed; fetch current profile before retrying."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"AgimpeApiKey":[]}]}},"/monitoring":{"get":{"tags":["Monitoring"],"summary":"Monitoring","description":"Return currently enabled monitoring entities and their selected topics.","operationId":"monitoring_monitoring_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringList"}}}}},"security":[{"AgimpeApiKey":[]}]}},"/matches":{"get":{"tags":["Matches"],"summary":"Matches","description":"List currently relevant matches, ordered by approval time and ID ascending.\n\nFollow next_cursor until null, even when items is empty (outdated candidates are\nfiltered). since is an inclusive approval timestamp with timezone. Data is live;\nuse an overlap window and upsert by ID when polling. Webhooks provide push events.","operationId":"matches_matches_get","security":[{"AgimpeApiKey":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}],"title":"Cursor"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Since"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/matches/{match_id}":{"get":{"tags":["Matches"],"summary":"Match Detail","operationId":"match_detail_matches__match_id__get","security":[{"AgimpeApiKey":[]}],"parameters":[{"name":"match_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Match Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/publications/{publication_id}":{"get":{"tags":["Matches"],"summary":"Publication Detail","description":"Only publications associated with a currently relevant match of this company.","operationId":"publication_detail_publications__publication_id__get","security":[{"AgimpeApiKey":[]}],"parameters":[{"name":"publication_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Publication Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicationOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CompanyOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"trade_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trade Name"},"cnpj":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cnpj"},"cnaes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cnaes"},"tax_regime":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Regime"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"default_locale":{"type":"string","title":"Default Locale"}},"type":"object","required":["id","name","trade_name","cnpj","cnaes","tax_regime","state","city","default_locale"],"title":"CompanyOut"},"EntityOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"EntityOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"MatchList":{"properties":{"items":{"items":{"$ref":"#/components/schemas/MatchOut"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["items","next_cursor"],"title":"MatchList"},"MatchOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"company_id":{"type":"string","format":"uuid","title":"Company Id"},"classification":{"type":"string","title":"Classification"},"available_at":{"type":"string","format":"date-time","title":"Available At"},"publication":{"$ref":"#/components/schemas/PublicationOut"},"entity":{"$ref":"#/components/schemas/EntityOut"}},"type":"object","required":["id","company_id","classification","available_at","publication","entity"],"title":"MatchOut"},"MonitoringList":{"properties":{"items":{"items":{"$ref":"#/components/schemas/MonitoringOut"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"MonitoringList"},"MonitoringOut":{"properties":{"entity":{"$ref":"#/components/schemas/EntityOut"},"all_topics":{"type":"boolean","title":"All Topics"},"topics":{"items":{"$ref":"#/components/schemas/TopicOut"},"type":"array","title":"Topics"}},"type":"object","required":["entity","all_topics","topics"],"title":"MonitoringOut"},"OperationOut":{"properties":{"profile":{"anyOf":[{"$ref":"#/components/schemas/ProfileOut"},{"type":"null"}]}},"type":"object","required":["profile"],"title":"OperationOut"},"ProfileInput":{"properties":{"expected_revision":{"type":"integer","minimum":0.0,"title":"Expected Revision"},"activities":{"items":{"type":"string"},"type":"array","maxItems":50,"title":"Activities"},"products":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Products"},"services":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Services"},"states":{"items":{"type":"string"},"type":"array","maxItems":27,"title":"States"},"cities":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Cities"},"customer_types":{"items":{"type":"string"},"type":"array","maxItems":50,"title":"Customer Types"},"regulatory_registrations":{"items":{"type":"string"},"type":"array","maxItems":50,"title":"Regulatory Registrations"},"related_terms":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Related Terms"},"imports":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Imports"},"exports":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Exports"}},"additionalProperties":false,"type":"object","required":["expected_revision"],"title":"ProfileInput"},"ProfileOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"revision":{"type":"integer","title":"Revision"},"data":{"additionalProperties":true,"type":"object","title":"Data"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","revision","data","updated_at"],"title":"ProfileOut"},"PublicationOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"title":{"type":"string","title":"Title"},"summary":{"type":"string","title":"Summary"},"official_url":{"type":"string","title":"Official Url"},"published_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Published On"}},"type":"object","required":["id","title","summary","official_url","published_on"],"title":"PublicationOut"},"TopicOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"keywords":{"items":{"type":"string"},"type":"array","title":"Keywords"}},"type":"object","required":["id","name","keywords"],"title":"TopicOut"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"AgimpeApiKey":{"type":"http","description":"Chave da empresa: ag_live_<id>.<segredo>. Uso exclusivo no servidor.","scheme":"bearer"}}},"servers":[{"url":"/api/integrations/v1"}]}