Skip to content
index.html 51.3 KiB
Newer Older
<p>With this the provider part would be finished.</p>
<h3 id="calling-the-api">Calling the API</h3>
<p>Finally, we will create an invoker with the user given by the administrator to be able to use the published api.</p>
<h4 id="06-getauth_invoker"><strong>06-getauth_invoker</strong></h4>
<p><img alt="Flow" src="../../images/flows/06_Invoker_Register_GetAuth.png" /></p>
<h4 id="07-onboard_invoker"><strong>07-onboard_invoker</strong></h4>
<p><img alt="Flow" src="../../images/flows/07_Invoker_Onboarding.png" /></p>
<h4 id="08-discover"><strong>08-discover</strong></h4>
<p>At this point we move on to using certificate authentication in CAPIF. <strong>If you did not configure the provider's certificates, you would have to do it now</strong>.</p>
<p><img alt="Flow" src="../../images/flows/08_Invoker_Discover_AEF.png" /></p>
<h4 id="09-security_context"><strong>09-security_context</strong></h4>
<p><img alt="Flow" src="../../images/flows/09_Invoker_Create_Security_Context.png" /></p>
<h4 id="10-get_token"><strong>10-get_token</strong></h4>
<p><img alt="Flow" src="../../images/flows/10_Invoker_Get_Token.png" /></p>
<h4 id="11-call_service"><strong>11-call_service</strong></h4>
<p><img alt="Flow" src="../../images/flows/11_Invoker_Send_Request_to_AEF_Service_API.png" /></p>
<p>With this, we would have made the API call and finished the flow.</p>
<h3 id="other-requests">Other requests</h3>
<p>Other requests that we have added are the following:</p>
<ul>
<li><strong>offboard_provider</strong>      Performs offboarding of the provider, thereby eliminating the published APIs.</li>
</ul>
<p><img alt="Flow" src="../../images/flows/Offboard_provider.png" /></p>
<ul>
<li><strong>offboard_invoker</strong>       Offboards the invoker, also eliminating access to the APIs of that invoker.</li>
</ul>
<p><img alt="Flow" src="../../images/flows/Offboard_Invoker.png" /></p>
<ul>
<li><strong>remove_user</strong>            Delete the user.</li>
</ul>
<p><img alt="Flow" src="../../images/flows/Remove_User.png" /></p>
<ul>
<li><strong>refresh_admin_token</strong>    Return a new access token to the admin.</li>
<p><img alt="Flow" src="../../images/flows/Refresh_Admin_Token.png" /></p>
<ul>
<li><strong>create_log</strong>    The AEF saves and sends the service consumption logs that it exposes to the CCF</li>
</ul>
<p><img alt="Flow" src="../../images/flows/AEF_Create_Log.png" /></p>
<ul>
<li><strong>get_log</strong>   The AEF requests the stored logs from the CCF</li>
</ul>
<p><img alt="Flow" src="../../images/flows/Provider_Get_Log.png" /></p>
<ul>
<li><strong>get_acl</strong>   The AEF requests the CCF for the access control list of invokers for its exposed service.</li>
</ul>
<p><img alt="Flow" src="../../images/flows/Provider_Get_ACL.png" /></p>
<h2 id="notes">Notes</h2>
<ul>
<li>This process is designed to teach how requests are made in Postman and the flow that should be followed to publish and use an API.</li>
<li>It is possible that if external CAPIFs are used (Public CAPIF) the test data may already be used or the API already registered.</li>
<li>It is necessary to have the Node service running to make the certificate change for the requests, otherwise it will not work.</li>
<li>We are working on adding more requests to the Postman collection.</li>
<li>This collection is a testing guide and is recommended for testing purposes only.</li>
</ul>












                
              </article>
            </div>
          
          
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
        </div>
        
          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
  Back to top
</button>
        
      </main>
      
        <footer class="md-footer">
  
    
      
      <nav class="md-footer__inner md-grid" aria-label="Footer" >
        
          
          <a href="../robotframework/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Robot Framework">
            <div class="md-footer__button md-icon">
              
              <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
            </div>
            <div class="md-footer__title">
              <span class="md-footer__direction">
                Previous
              </span>
              <div class="md-ellipsis">
                Robot Framework
              </div>
            </div>
          </a>
        
        
          
          <a href="../../sandbox/sandbox/" class="md-footer__link md-footer__link--next" aria-label="Next: Introduction">
            <div class="md-footer__title">
              <span class="md-footer__direction">
                Next
              </span>
              <div class="md-ellipsis">
              </div>
            </div>
            <div class="md-footer__button md-icon">
              
              <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
            </div>
          </a>
        
      </nav>
    
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-copyright">
  
    <div class="md-copyright__highlight">
      Copyright &copy; 2019-2024 OpenCAPIF Project
    </div>
  
  
    Made with
    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
      Material for MkDocs
    </a>
  
</div>
      
  
    
    
    
    
      
      
    
    <a href="https://ocf.etsi.org/" target="_blank" rel="noopener" title="ocf.etsi.org" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M351.9 280H161c2.9 64.5 17.2 123.9 37.5 167.4 11.4 24.5 23.7 41.8 35.1 52.4 11.2 10.5 18.9 12.2 22.9 12.2s11.7-1.7 22.9-12.2c11.4-10.6 23.7-28 35.1-52.4 20.3-43.5 34.6-102.9 37.5-167.4zm-191-48h190.9c-2.8-64.5-17.1-123.9-37.4-167.4-11.4-24.4-23.7-41.8-35.1-52.4C268.1 1.7 260.4 0 256.4 0s-11.7 1.7-22.9 12.2c-11.4 10.6-23.7 28-35.1 52.4-20.3 43.5-34.6 102.9-37.5 167.4m-48 0c3.5-85.6 25.6-165.1 57.9-217.3C78.7 47.3 10.9 131.2 1.5 232zM1.5 280c9.4 100.8 77.2 184.7 169.3 217.3-32.3-52.2-54.4-131.7-57.9-217.3zm398.4 0c-3.5 85.6-25.6 165.1-57.9 217.3 92.1-32.7 159.9-116.5 169.3-217.3zm111.4-48C501.9 131.2 434.1 47.3 342 14.7c32.3 52.2 54.4 131.7 57.9 217.3z"/></svg>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://labs.etsi.org/rep/ocf" target="_blank" rel="noopener" title="labs.etsi.org" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="m504 204.6-.7-1.8L433.6 21c-1.4-3.6-3.9-6.6-7.2-8.6-2.4-1.6-5.1-2.5-8-2.8s-5.7.1-8.4 1.1-5.1 2.7-7.1 4.8c-1.9 2.1-3.3 4.7-4.1 7.4l-47 144H161.3l-47.1-144c-.8-2.8-2.2-5.3-4.1-7.4-2-2.1-4.4-3.7-7.1-4.8-2.6-1-5.5-1.4-8.4-1.1s-5.6 1.2-8 2.8c-3.2 2-5.8 5.1-7.2 8.6L9.8 202.8l-.8 1.8c-10 26.2-11.3 55-3.5 82 7.7 26.9 24 50.7 46.4 67.6l.3.2.6.4 106 79.5c38.5 29.1 66.7 50.3 84.6 63.9 3.7 1.9 8.3 4.3 13 4.3s9.3-2.4 13-4.3c17.9-13.5 46.1-34.9 84.6-63.9l106.7-79.9.3-.3c22.4-16.9 38.7-40.6 45.6-67.5 8.6-27 7.4-55.8-2.6-82"/></svg>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://www.linkedin.com/company/opencapif/" target="_blank" rel="noopener" title="www.linkedin.com" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3M135.4 416H69V202.2h66.5V416zM102.2 96a38.5 38.5 0 1 1 0 77 38.5 38.5 0 1 1 0-77m282.1 320h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9z"/></svg>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://twitter.com/OpenCAPIF" target="_blank" rel="noopener" title="twitter.com" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M357.2 48h70.6L273.6 224.2 455 464H313L201.7 318.6 74.5 464H3.8l164.9-188.5L-5.2 48h145.6l100.5 132.9zm-24.8 373.8h39.1L119.1 88h-42z"/></svg>
    </a>
  
</div>
      
    </div>
  </div>
</footer>
      
    </div>
    <div class="md-dialog" data-md-component="dialog">
      <div class="md-dialog__inner md-typeset"></div>
    </div>
    
      <div class="md-progress" data-md-component="progress" role="progressbar"></div>
    
    
      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
        <script src="../../assets/swagger/swagger-ui-bundle.js"></script>
      
        <script src="../../assets/swagger/swagger-ui-standalone-preset.js"></script>