This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.crif.com/
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
Put the package under your project folder and add the following in import:
import crifmargo "github.com/Hevelop/go-client-crif-margo"
To use a proxy, set the environment variable HTTP_PROXY
:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Default configuration comes with Servers
field that contains server objects as defined in the OpenAPI specification.
For using other server than the one defined on index 0 set context value crifmargo.ContextServerIndex
of type int
.
ctx := context.WithValue(context.Background(), crifmargo.ContextServerIndex, 1)
Templated server URL is formatted using default variables from configuration or from context value crifmargo.ContextServerVariables
of type map[string]string
.
ctx := context.WithValue(context.Background(), crifmargo.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
Each operation can use different server URL defined using OperationServers
map in the Configuration
.
An operation is uniquely identified by "{classname}Service.{nickname}"
string.
Similar rules for overriding default operation server index and variables applies by using crifmargo.ContextOperationServerIndices
and crifmargo.ContextOperationServerVariables
context maps.
ctx := context.WithValue(context.Background(), crifmargo.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), crifmargo.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
All URIs are relative to https://api-uat.crif.com/margo/v1
Class | Method | HTTP request | Description |
---|---|---|---|
CommonAPI | GetDomain | Get /domains/{domainType} | Get values of the domainType indicated |
CommonAPI | GetDomains | Get /domains | List all domains |
OrganizationAPI | GetProducts | Get /products | List all products |
OrganizationAPI | PostProducts | Post /products | Create product |
PortfoliosAPI | DeletePortfolio | Delete /portfolios/{portfolioId} | Delete a portfolio |
PortfoliosAPI | DeleteSharingPortfolio | Delete /portfolios/{portfolioId}/share | Delete Sharing a Portfolio |
PortfoliosAPI | GetPortfolio | Get /portfolios/{portfolioId} | Get a portfolio |
PortfoliosAPI | GetPortfolios | Get /portfolios | List all portfolios |
PortfoliosAPI | PortfolioSharesDelete | Post /portfolios/{portfolioId}/shares/delete | Delete Portfolio shares |
PortfoliosAPI | PortfolioSharingList | Get /portfolios/{portfolioId}/share | Share a Portfolio |
PortfoliosAPI | PostAddPortfolioCompanies | Post /portfolios/{portfolioId}/companies/bulk-add | Add companies to portfolio |
PortfoliosAPI | PostDeletePortfolioCompanies | Post /portfolios/{portfolioId}/companies/bulk-delete | Delete companies from portfolio |
PortfoliosAPI | PostPortfolioDownload | Post /portfolios/{portfolioId}/download | Download portfolio |
PortfoliosAPI | PostPortfolios | Post /portfolios | Create portfolio |
PortfoliosAPI | PostSimilarity | Post /portfolios/{portfolioId}/create-similarity | Generate prospect based on own portfolio |
PortfoliosAPI | PostUpdatePortfolioCompanies | Post /portfolios/{portfolioId}/companies/bulk-update | Update companies to portfolio |
PortfoliosAPI | SharePortfolio | Post /portfolios/{portfolioId}/share | Share a Portfolio |
ProfileAPI | GetOfficeUsers | Get /offices/{officeId}/users | Get users list of the office |
ProfileAPI | GetOffices | Get /offices | List all offices |
ProspectingAPI | PostSearch | Post /prospecting/search | Search companies |
- AccessRight
- CompanyArrayType
- CompanyMargoIdArrayType
- CompanyResultType
- CompanyType
- CompanyUpdateArrayType
- CompanyUpdateType
- CustomVariableType
- CustomVariablesFiltersType
- CustomVariablesFiltersTypeBooleanfiltersInner
- CustomVariablesFiltersTypeDatefiltersInner
- CustomVariablesFiltersTypeNumericfiltersInner
- CustomVariablesFiltersTypeStringfiltersInner
- DataPacketArrayType
- DateFilterType
- DomainArrayMetadataType
- DomainArrayType
- DomainType
- DomainsType
- DownloadCompanyDataType
- DownloadCompanyDataTypeEcofin
- DownloadCompanyDataTypePortfolioInformation
- DownloadCompanyDataTypePortfolioInformationAreaManager
- DownloadCompanyDataTypePortfolioInformationCustomVariablesInner
- DownloadCompanyDataTypePortfolioInformationProduct
- DownloadCompanyDataTypePortfolioInformationSales
- DownloadDataArrayType
- DownloadResultType
- DownloadType
- DownloadTypeContent
- ErrorType
- FaultType
- FiltersType
- FiltersTypeBooleanfiltersInner
- FiltersTypeDatefiltersInner
- FiltersTypeDomainfiltersInner
- FiltersTypeNumericfiltersInner
- FiltersTypeStringfiltersInner
- MarketingListType
- MetadataType
- NumericFilterType
- OfficeArrayMetadataType
- OfficeArrayType
- OfficeType
- OfficesList
- PortfolioCreationType
- PortfolioFiltersType
- PortfolioFiltersTypeAmount
- PortfolioSummaryArrayMetadataType
- PortfolioSummaryArrayType
- PortfolioSummaryType
- PortfolioType
- PortfolioTypeCompaniesPortfolioStatus
- ProductArrayMetadataType
- ProductArrayType
- ProductType
- ResponseErrorType
- SearchCompanyDataType
- SearchCompanyDataTypeAddress
- SearchCompanyDataTypeAddressCountry
- SearchCompanyDataTypeAddressProvince
- SearchCompanyDataTypeAddressRegion
- SearchCompanyDataTypeAffidabilityScore
- SearchCompanyDataTypeAffiliateCompaniesInner
- SearchCompanyDataTypeArtisanBusinessRegistry
- SearchCompanyDataTypeArtisanBusinessRegistryArtisanBusinessRegistry
- SearchCompanyDataTypeAssetsAggregateValuesInner
- SearchCompanyDataTypeAteco
- SearchCompanyDataTypeAtecoClassification
- SearchCompanyDataTypeBranches
- SearchCompanyDataTypeBranchesBrancheType
- SearchCompanyDataTypeCompanyDates
- SearchCompanyDataTypeCompanyDetails
- SearchCompanyDataTypeCompanyIdentification
- SearchCompanyDataTypeCompanyStatus
- SearchCompanyDataTypeCompanyStatusActivityStatus
- SearchCompanyDataTypeContacts
- SearchCompanyDataTypeCorporateGroups
- SearchCompanyDataTypeCorporateGroupsNationalParentCompany
- SearchCompanyDataTypeCorporateGroupsNationalParentCompanyCountry
- SearchCompanyDataTypeCorporateGroupsNationalParentCompanyProvince
- SearchCompanyDataTypeCoverageRatios
- SearchCompanyDataTypeCreditNeeds
- SearchCompanyDataTypeCreditNeedsEquipmentLeaseScore
- SearchCompanyDataTypeCreditNeedsFactoringScore
- SearchCompanyDataTypeCreditNeedsRealEstateLeaseScore
- SearchCompanyDataTypeCreditNeedsShortTermScore
- SearchCompanyDataTypeCribisDnBRating
- SearchCompanyDataTypeCribisScoreStateOwned
- SearchCompanyDataTypeCrifBusinessIndex
- SearchCompanyDataTypeDevelopment
- SearchCompanyDataTypeDigitalAttitudeScore
- SearchCompanyDataTypeEcofin
- SearchCompanyDataTypeEcofinEnterpriseSize
- SearchCompanyDataTypeEcofinTurnoverRange
- SearchCompanyDataTypeEfficiency
- SearchCompanyDataTypeEmployees
- SearchCompanyDataTypeEmployeesEmployeeRange
- SearchCompanyDataTypeEmployeesStatistic
- SearchCompanyDataTypeFinancialBurden
- SearchCompanyDataTypeFinancialCycle
- SearchCompanyDataTypeFinancialStability
- SearchCompanyDataTypeFinancialStatementKpi
- SearchCompanyDataTypeForeignTrade
- SearchCompanyDataTypeGeoCoordinates
- SearchCompanyDataTypeGovernanceRiskIndex
- SearchCompanyDataTypeIndebtedness
- SearchCompanyDataTypeInnovationScore
- SearchCompanyDataTypeInnovativeSmeAndSu
- SearchCompanyDataTypeInternationalClassification
- SearchCompanyDataTypeInternationalClassificationNace
- SearchCompanyDataTypeInternationalClassificationPrimarySic
- SearchCompanyDataTypeInternationalIdentification
- SearchCompanyDataTypeInternazionalizationScore
- SearchCompanyDataTypeIsoCertificationsInner
- SearchCompanyDataTypeIstatTownCode
- SearchCompanyDataTypeLegalForm
- SearchCompanyDataTypeLegalFormDetailedLegalForm
- SearchCompanyDataTypeLegalFormLegalForm
- SearchCompanyDataTypeLeverageRatios
- SearchCompanyDataTypeLiquidityRatios
- SearchCompanyDataTypeMail
- SearchCompanyDataTypeManagersInner
- SearchCompanyDataTypeManagersInnerGender
- SearchCompanyDataTypeManagersInnerRolesInner
- SearchCompanyDataTypeManagersInnerRolesInnerRole
- SearchCompanyDataTypeMarketable
- SearchCompanyDataTypeOfficeType
- SearchCompanyDataTypeOperatingResults
- SearchCompanyDataTypeProfitability
- SearchCompanyDataTypePublicTendersInner
- SearchCompanyDataTypeRetailAnalytics
- SearchCompanyDataTypeSeasonality
- SearchCompanyDataTypeSeasonalityWinter
- SearchCompanyDataTypeSemanticCluster
- SearchCompanyDataTypeShareholdersInfoInner
- SearchCompanyDataTypeShareholdersInfoInnerShareholdersInner
- SearchCompanyDataTypeSoaCertification
- SearchCompanyDataTypeStateOwned
- SearchCompanyDataTypeStateOwnedStateOwnedType
- SearchCompanyDataTypeStateOwnedTelco
- SearchCompanyDataTypeStructureRatios
- SearchCompanyDataTypeSubsidiariesInner
- SearchCompanyDataTypeSubsidiariesInnerProvince
- SearchCompanyDataTypeSupplierScore
- SearchCompanyDataTypeTelcoAnalytics
- SearchCompanyDataTypeTelcoAnalyticsLandLineScore
- SearchCompanyDataTypeTelcoAnalyticsMobileScore
- SearchCompanyDataTypeTerritorialScore
- SearchCompanyDataTypeUtilities
- SearchCompanyDataTypeUtilitiesElectricityScore
- SearchCompanyDataTypeUtilitiesGasScore
- SearchCompanyDataTypeWebAndSocial
- SearchDataArrayMetadataType
- SearchDataArrayType
- SearchType
- SearchTypeContent
- SimilarityResultType
- UserArrayMetadataType
- UserArrayType
- UserType
Authentication schemes defined for the API:
- Type: OAuth
- Flow: password
- Authorization URL:
- Scopes: N/A
Example
auth := context.WithValue(context.Background(), crifmargo.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
Or via OAuth2 module to automatically refresh tokens and perform user authentication.
import "golang.org/x/oauth2"
/* Perform OAuth2 round trip request and obtain a token */
tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, crifmargo.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime