README.md•4.93 kB
��# b r a z i l i a n - c e p - m c p
# # D e s c r i � � o
E s t e � u m s e r v i d o r M C P ( M o d e l C o n t e x t P r o t o c o l ) q u e f o r n e c e f e r r a m e n t a s p a r a c o n s u l t a d e i n f o r m a � � e s d e C � d i g o s d e E n d e r e � a m e n t o P o s t a l ( C E P ) b r a s i l e i r o s . O s e r v i d o r u t i l i z a a A P I V i a C E P p a r a o b t e r d a d o s d e t a l h a d o s d e e n d e r e � o s a p a r t i r d o C E P i n f o r m a d o .
# # F u n c i o n a l i d a d e s
- C o n s u l t a d e e n d e r e � o s c o m p l e t o s a t r a v � s d o C E P
- R e t o r n o d e i n f o r m a � � e s c o m o l o g r a d o u r o , b a i r r o , c i d a d e , e s t a d o , r e g i � o , D D D e c � d i g o I B G E
- I m p l e m e n t a � � o d o p r o t o c o l o M C P p a r a i n t e g r a � � o c o m a g e n t e s d e I A
# # I n s t a l a � � o
` ` ` b a s h
# C l o n e o r e p o s i t � r i o
g i t c l o n e h t t p s : / / g i t h u b . c o m / g u i l h e r m e l i r i o / b r a z i l i a n - c e p - m c p . g i t
c d b r a z i l i a n - c e p - m c p
# I n s t a l e a s d e p e n d � n c i a s
n p m i n s t a l l
` ` `
# # C o m o u s a r
# # # C o m p i l a � � o d o p r o j e t o
P a r a c o m p i l a r o c � d i g o T y p e S c r i p t :
` ` ` b a s h
n p m r u n b u i l d
` ` `
# # # E x e c u � � o d o s e r v i d o r
P a r a i n i c i a r o s e r v i d o r e m m o d o d e d e s e n v o l v i m e n t o :
` ` ` b a s h
n p m r u n d e v
` ` `
P a r a i n i c i a r o s e r v i d o r a p � s c o m p i l a � � o :
` ` ` b a s h
n p m s t a r t
` ` `
# # # C o n s u l t a n d o u m C E P
O s e r v i d o r d i s p o n i b i l i z a a f e r r a m e n t a ` c o n s u l t a r - c e p ` q u e a c e i t a u m p a r � m e t r o :
- ` c e p ` : C � d i g o p o s t a l n o f o r m a t o d e 8 d � g i t o s n u m � r i c o s ( o b r i g a t � r i o )
E x e m p l o d e u s o :
` ` ` j s o n
{
" c e p " : " 0 1 0 0 1 0 0 0 "
}
` ` `
R e s p o s t a :
` ` `
E n d e r e � o e n c o n t r a d o :
C E P : 0 1 0 0 1 - 0 0 0
L o g r a d o u r o : P r a � a d a S �
C o m p l e m e n t o : l a d o � m p a r
B a i r r o : S �
C i d a d e : S � o P a u l o
E s t a d o : S P ( S � o P a u l o )
R e g i � o : S u d e s t e
D D D : 1 1
I B G E : 3 5 5 0 3 0 8
` ` `
# # T e c n o l o g i a s u t i l i z a d a s
- T y p e S c r i p t
- N o d e . j s
- A x i o s p a r a r e q u i s i � � e s H T T P
- Z o d p a r a v a l i d a � � o d e e s q u e m a s
- S D K d o M o d e l C o n t e x t P r o t o c o l
# # C o n f i g u r a � � o S m i t h e r y
E s t e p r o j e t o e s t � c o n f i g u r a d o p a r a f u n c i o n a r c o m a p l a t a f o r m a S m i t h e r y . a i , q u e f a c i l i t a a d i s t r i b u i � � o e e x e c u � � o d e s e r v i d o r e s M C P .
# # E s t r u t u r a d o p r o j e t o
` ` `
b r a z i l i a n - c e p - m c p /
% % % s r c /
% % % % i n d e x . t s # C � d i g o - f o n t e p r i n c i p a l
% % % d i s t / # C � d i g o c o m p i l a d o
% % % n o d e _ m o d u l e s / # D e p e n d � n c i a s
% % % s m i t h e r y . y a m l # C o n f i g u r a � � o d o S m i t h e r y
% % % p a c k a g e . j s o n # C o n f i g u r a � � o d o p r o j e t o
% % % t s c o n f i g . j s o n # C o n f i g u r a � � o d o T y p e S c r i p t
% % % R E A D M E . m d # E s t e a r q u i v o
` ` `
# # A u t o r
G u i l h e r m e L i r i o T o m a s i d e O l i v e i r a
# # L i c e n � a
E s t e p r o j e t o e s t � l i c e n c i a d o s o b a l i c e n � a M I T - v e j a o a r q u i v o [ L I C E N S E ] ( L I C E N S E ) p a r a m a i s d e t a l h e s .
# # C o n t r i b u i � � e s
C o n t r i b u i � � e s s � o b e m - v i n d a s ! S i n t a - s e � v o n t a d e p a r a a b r i r i s s u e s o u e n v i a r p u l l r e q u e s t s .